Contributing to Website Documentation Guide¶
The documentation for our website is located within the docs directory of our git repository. When the master branch of this git repository is updated with a new commit, Read the Docs automatically builds and hosts the documentation within the docs folder to our documentation site. The status of the documentation build displays whether or not the documentation successfully builds on Read the Docs.
How to Create a New Documentation Site¶
Refer to the Getting Started guide within the Read the Docs website, and refer to the above helpful links in order for syntax reference. Take a look at the Quick Start video for information about developing the documentation locally. Also, be sure to include a line that contains master_doc = 'index' within the conf.py file in order to successfully build on Read the Docs as mentioned here.