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.
- On Windows:
- On Linux:
_build/html/filename.htmlin your browser of choice. (If that’s IE, rethink your life choices.)
Creating Subsystem docs¶
- Fill out the file
- Add, commit, and push. Read The Docs should automatically build the new HTML pages for you.