docs folder overview

This folder contains documentation for govcookiecutter. These are written in MyST Markdown files with Sphinx compatibility.

Warning

Further details to consider when modifying these files are supplied in the contributing guidance.

To include documentation from the {{ cookiecutter.repo_name }} folder without duplicating it, refer to it in a file within the docs/{{ cookiecutter.repo_name }} folder.

To build the documentation, run:

sphinx-build -b html ./docs ./docs/_build

Unix and Linux users can alternatively run the docs command from Makefile using the make utility at the top-level of this repository.

make docs

The HTML-version of this documentation can then be viewed at docs/_build/index.html, relative to the top-level of this repository.