The expression “reST/Sphinx” makes the scope of the question unclear. Is it about reStructuredText in general and Sphinx, or only about reStructuredText as used in Sphinx (and not reStructuredText in general)? I’m going to cover both since people using RST are likely to run into both cases at some point: Sphinx Besides the domain-specific directives … Read more
You can check this script that I’ve made. I think it can help you. This script parses a directory tree looking for python modules and packages and creates ReST files appropriately to create code documentation with Sphinx. It also creates a modules index. UPDATE This script is now part of Sphinx 1.1 as apidoc.
Here is a way to accomplish what the OP asks for: Add an __all__ list in pkg/__init__.py: from base import Base # Or use ‘from base import *’ __all__ = [“Base”] Use .. automodule:: pkg in the .rst file. Sphinx will now output documentation where the class name is shown as pkg.Base instead of pkg.base.Base.
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