You don’t need to add labels. In order to refer to a Python class, method, or other documented object, use the markup provided by the Python domain. For example, the following defines a cross-reference to the mymethod method: :py:meth:`mymodule.MyClass.mymethod` Or even simpler (since the Python domain is the default): :meth:`mymodule.MyClass.mymethod` The documentation of TextWrapper.wrap that … Read more
The autosummary extension, with the autosummary_generate configuration variable set to True, can be used to 1) generate compact summary listings and 2) generate class documentation with one page per class. You have to explicitly specify each class to be included, but once this is done you have a setup for generating clear documentation where the … Read more
Since version 4.0 of Sphinx there is a new configuration option (autodoc_preserve_defaults). Setting autodoc_preserve_defaults = True in your conf.py will preserve the default values as they are in the source code.
Autodoc can’t find your modules, because they are not in sys.path. You have to include the path to your modules in in the sys.path in your conf.py. Look at the top of your conf.py (just after the import of sys), there is a sys.path.insert() statement, which you can adapt. By the way: you can use … 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.
This is the usual “canonical approach” to “getting started” applied to the case when your source code resides in a src directory like Project/src instead of simply being inside the Project base directory. Follows these steps: Create a docs directory in your Project directory (it’s from this docs directory the commands in the following steps … Read more
You have a module-level variable that is used as the default value of a keyword argument in a function. Sphinx displays the value (instead of the name) of that variable in the function signature. This problem is discussed in another question, and the OP has also submitted an issue ticket at GitHub about it. However, … 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.
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