5.7. Documentation Style GuideΒΆ
- Documentation uses Sphinx documentation generator.
- Documentation is hosted on ReadTheDocs
- File issues if you notice bugs in documentation or to request more information.
Label issues with
doc
- Contributions to documentation is accepted as a Pull Request.
- Choose Markdown if you will add new pages
- Choose Rich Structured Text (rst) for indexes or if the documentation needs tables.
- To locally test docs changes run
python -msphinx . _build
insidedocs
directory