python - Moving from epydoc to sphinx to auto-document a simple python .py file

Question

Epydoc is not working good anymore, even after applying patches, so I'm trying to move to Sphinx.

I want to auto-generate documentation from a simple python file: test.py

After installing and running sphinx-quickstart-script I copied test.py to the source folder and typed:

sphinx-build -b html .\source .\build

But it only produces the minimiun html files, and it does not parse the test.py file

I'm run out of ideas.

Thanks for your help :)

Answer 1

You have to include sphinx.ext.autodoc as an extension in your conf.py (https://www.sphinx-doc.org/en/master/usage/configuration.html), than you can document your module using the .. automodule:: directive (or objects from this module with .. autoclass::, .. autofunction::, ...).

See https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

Answer 2

For auto-generating the necessary .rst files you can use sphinx-apidoc.

This makes life much easier. So you don' t have to document each of your modules manually.