This repository contains documentation for Aviatrix written using the reStructuredText format.
HTML documentation is generated using Sphinx. Shortly after a commit is pushed to this repository, the latest source is turned into HTML files and published to docs.aviatrix.com.
If you'd like to generate the documentation yourself, follow the steps outlined below:
-
Install the latest version of Sphinx
-
Install sphinx-rtd-theme
pip install sphinx-rtd-theme -
Install sphinxcontrib-disqus
pip install sphinxcontrib-disqus
To generate the output, use the sphinx-build command. It has a lot of options; but, the simple case of generating HTML output looks like:
sphinx-build -b html . ./output
