Contributing¶
All documentation changes must be done on the branch feature/documentation
, under penalty of commit reversion.
Previewing your changes¶
- You should do this before you commit.
cd docs
- OS-Dependent:
- On Windows:
.\make html
- On Linux:
make html
- Open
_build/html/filename.html
in your browser of choice. (If that’s IE, rethink your life choices.)
Creating Subsystem docs¶
- Copy
_templates/subsystem.rst
intodocs/name_of_sub_system.rst
- Fill out the file
- Add, commit, and push. Read The Docs should automatically build the new HTML pages for you.