On Python Documentation with Sphinx
I’ve been exploring the Python documentation system for ReadTheDocs with Sphinx. It could be that I’m dense, but the
sphinx-quickstart command seems horribly divorced from most of the automagic documentation goals of the Sphinx project. After following several guides1, 2 I noticed that only an index.rst had been created in the
_sources directory. Brandon’s guide suggests that adding your module to either your PYTHONPATH or to your conf.py before
make html would lead to autodoc recognizing your package. I wasn’t able to get this to work on OSX Sierra using a virtualenv. After looking through more tutorials, I encountered some suggestions for the
sphinx-apidoc command, without actual invocation details.