Updated the contributing guide to include instructions on how to generate sphinx reference documentation locally
Fixes #(issue) - N/A
Why is the change necessary?
Sphinx reference docs can't be rendered directly in your IDE and it is useful to be able to generate the docs locally to visualize your changes before merging them. For example, we use autodoc to document classes - these instructions will make it possible to visualize the documentation locally (including docstrings)
Description
Updated the contributing guide to include instructions on how to generate sphinx reference documentation locally
Fixes #(issue) - N/A
Why is the change necessary?
Sphinx reference docs can't be rendered directly in your IDE and it is useful to be able to generate the docs locally to visualize your changes before merging them. For example, we use autodoc to document classes - these instructions will make it possible to visualize the documentation locally (including docstrings)
Solution
Provide instructions to generate the documentation in
/doc
locally based on PyCharm's Generating Reference Documentation Using SphinxNote: We don't need to do Tools | Sphinx quickstart since we already have a
conf.py
file in the/doc
directoryAlso in this PR:
Testing
Generated the documentation locally following the added instructions
Pull Request Checklist
Please check all boxes (including N/A items)
Testing
Documentation
Title and description
Fixes #xxx
- N/ABy submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.