Updating the documentation¶
Simple instructions¶
Simply commit and push the code to github.
You can actually edit and preview changes directly in github!
The changes will be uploaded to readthedocs automatically through webHooks.
Difficult instructions¶
If you want to see the resulting html before you commit (usually you don’t need to):
Run:
pip install sphinx
Make the updates you want to the .rst files, and then run:
make html
Open the index.html file in the browser to see the result.