This folder generates the Orca online documentation, hosted at https://udst.github.io/orca/.
HTML files are generated using Sphinx and hosted with GitHub Pages from the gh-pages branch of the repository. The online documentation is rendered and updated manually.
The files in docs/source, along with docstrings in the source code, determine what appears in the rendered documentation. Here's a good tutorial for Sphinx.
Install the copy of Orca that the documentation is meant to reflect. Install the documentation tools.
pip install .
pip install sphinx sphinx_rtd_theme numpydoc
Build the documentation. There should be status messages and warnings, but no errors.
cd docs
sphinx-build -b html source build
The HTML files will show up in docs/build/.
Clone a second copy of the repository and check out the gh-pages branch. Copy over the updated HTML files, commit them, and push the changes to GitHub.