sphinx-apidoc - w3toppers.com

How to document Python packages using Sphinx

Here is an outline: Document your package using docstrings in the sources. Use sphinx-quickstart to create a Sphinx project. Run sphinx-apidoc to generate .rst sources set up for use with autodoc. More information here. Using this command with the -F flag also creates a complete Sphinx project. If your API changes a lot, you may … Read more

Sphinx’s autodoc’s automodule having apparently no effect

I’ll try answering by putting the “canonical” approach side-by-side with your case. The usual “getting started approach” follows these steps: create a doc directory in your project directory (it’s from this directory the commands in the following steps are executed). sphinx-quickstart (choosing separate source from build). sphinx-apidoc -o ./source .. make html This would yield … Read more