You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
PurpleDome/doc/source/extending/documentation.rst

28 lines
552 B
ReStructuredText

===========================
Extending the documentation
===========================
The documentation is Sphinx based.
Tools being used for documentation are:
* Argparse for my command line tools
- https://github.com/alex-rudakov/sphinx-argparse
* Standard "autodoc" for python code
- https://www.sphinx-doc.org/en/master/usage/quickstart.html#autodoc
* Pyreverse
- https://pypi.org/project/sphinx-pyreverse/
* Autoyaml
- https://github.com/Jakski/sphinxcontrib-autoyaml
* Asciinema
- https://pypi.org/project/sphinxcontrib.asciinema/