Once you’ve got a local copy, you can edit the files in the docs/ directory to make changes. You may find the official Sphinx reStructuredText
primer useful for that.

To see the changes rendered locally, you can run the render_docs.py script found in the tools folder of the oh-mainline repository:

pythontools/render_docs.py

You will find the documentation rendered into html format inside the docs/html folder of the oh-mainline repository. You can view it in your
browser and check that you like your changes before submitting them. (Again, see Git Basics for
help submitting your changes.)

Once you submit your changes as a pull request and they have been merged by a maintainer, they will appear in the openhatch/oh-mainline repository.
The openhatch.readthedocs.org/ files will update automatically via a github web hook.

Note

If you’ve create a new file or edited/deleted a “toctree”, you may get an error “WARNING: document isn’t included in any toctree”. This means
a file is not referenced by a table of contents anywhere. Consider adding it to one. See Sphinx guide or reference.)

If you’re having trouble navigating the documentation by opening and editing files locally, you can also try paging through the readthedocs.
Each page should have an ‘Edit on Github’ link in the righthand corner. When you click this link, Github will automatically create a fork
of the project for you (if one does not automatically exist). Once you finish editing, make sure to submit a pull request.