mirror of https://github.com/avast/PurpleDome
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.
28 lines
564 B
ReStructuredText
28 lines
564 B
ReStructuredText
=================================
|
|
Contributing to the documentation
|
|
=================================
|
|
|
|
The documentation is Sphinx based.
|
|
|
|
Tools 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/ |