sphinx.ext.autosummary – Generate autodoc summaries
New in version 0.6.
This extension generates function/method/attribute summary lists, similar to those output e.g. by Epydoc and other API doc generation tools. This is especially useful when your docstrings are long and detailed, and putting each one of them on a separate page makes them easier to read.
The
Name of the documented object, excluding the module and class parts.
- objname
Name of the documented object, excluding the module parts.
- fullname
Full name of the documented object, including module and class parts.
- module
Name of the module the documented object belongs to.
- class
Name of the class the documented object belongs to. Only available for methods and attributes.
- underline
A string containing len(full_name) * '='.
- members
List containing names of all members of the module or class. Only available for modules and classes.
- functions
List containing names of “public” functions in the module. Here, “public” here means that the name does not start with an underscore. Only available for modules.
- classes
List containing names of “public” classes in the module. Only available for modules.
- exceptions
List containing names of “public” exceptions in the module. Only available for modules.
- methods
List containing names of “public” methods in the class. Only available for classes.
- attributes
List containing names of “public” attributes in the class. Only available for classes.
Note
You can use the autosummary directive in the stub pages. Stub pages are generated also based on these directives.