pip install -r docs/requirements.txt
Extra requirements only for development:
pip install -r docs/requirements.dev.txt
cd docs
make help
make html
make watch
Use Python Developer’s Guide as a reference for writing RST, specific rules are listed in the CONTRIBUTING file.
rm -r env
python -m venv env
source env/bin/activate
pip install -r docs/requirements.direct.txt
pip freeze > docs/requirements.txt
- Sphinx Documentation
- reStructuredText Markup Specification
- RST Cheatsheet
- Git Basics
- How to Write a Git Commit Message
This project is licensed under the Creative Commons Attribution-ShareAlike (CC BY-SA) - see the LICENSE file for more details.
Headings should use the following syntax for specific levels:
Chapter (page)
**************
Section
=======
Subsection
----------
Subsubsection
^^^^^^^^^^^^^
Paragraph
"""""""""Always the number of characters should match length of the text.