The documentation is built with Sphinx. See their documentation for (a lot) more details.
To generate the docs yourself, you'll need the appropriate package:
conda install sphinx
conda install sphinx_rtd_theme
pip install ghp-import
pip install sphinx-click
- Create a new file .rest file in source/_cli
- Add the following to the top of the new CLI module's .rst file:
.. click:: module_path:main
:prog: CLI-Alias # e.g. Sup3r
:show-nested:
git pushchanges to the documentation source code as needed.- Make the documentation per below
make html
make.bat html
To build a PDF, you'll need a latex distribution for your system.
make latexpdf
make.bat latexpdf
make github
make.bat html
Then run the github-related commands by hand:
git branch -D gh-pages
git push origin --delete gh-pages
ghp-import -n -b gh-pages -m "Update documentation" ./_build/html
git checkout gh-pages
git push origin gh-pages
git checkout master # or whatever branch you were on