Documentation

The STIG Manager OSS Documentation is written in reStructuredText. Sphinx and the Read The Docs theme is used to generate the site, which is located in the project repo and hosted on Read The Docs: stig-manager.readthedocs.io and on GitHub Pages: nuwcdivnpt.github.io

Documentation Build

To build the documentation locally:

1. Clone the STIG Manager repository from GitHub.

2. Install Python

3. Install Sphinx pip install sphinx

4. Navigate to /docs folder of the repository.

5. Install the following sphinx extensions using the pip install command (listed in the extensions array of the local conf.py file):

   • sphinx-rtd-theme

   • recommonmark

   • sphinxcontrib.images

6. Depending on the OS you are using, build the documentation using make.bat or the Makefile, and specify html as the format. Windows PowerShell example: ./make html

By default, the build product is located in _build in the docs directory.