Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Improvement [docs]: Build API reference docs with sphinx #573
Determine whether it would be beneficial to build reference documentation with sphinx that could get published on RTD.
Other projects publish reference guides (see: here) that can be helpful for users to both understand the code base and to use your modules more easily.
The main difference between our project and the one linked to is that we have chosen to use Google style docstrings in lieu of the Sphinx style docstrings.
The good news is, there is a sphinx extension by the name of sphinxcontrib.napoleon that adds support for parsing Google style docstrings to build reference docs.