IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Remove docs for autosummary features that are not actually in 0.6.

Browse Source
This commit is contained in:
Georg Brandl 2010-02-21 21:46:07 +01:00
parent b9dd04176f
commit b81b7a0463
1 changed files with 0 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
doc/ext/autosummary.rst
View File

@ -85,18 +85,6 @@ The :mod:`sphinx.ext.autosummary` extension does this in two parts:
sphinx.environment.BuildEnvironment
sphinx.util.relative_uri
* You can specify a custom template with the ``template`` option.
For example, ::
.. autosummary::
:template: mytemplate.rst
sphinx.environment.BuildEnvironment
would use the template :file:`mytemplate.rst` in your
:confval:`templates_path` to generate the pages for all entries
listed. See `Customizing templates`_ below.
:program:`sphinx-autogen` -- generate autodoc stub pages
--------------------------------------------------------
@ -134,89 +122,3 @@ also use this new config value:
The new files will be placed in the directories specified in the
``:toctree:`` options of the directives.
Customizing templates
---------------------
You can customize the stub page templates, in a similar way as the HTML Jinja
templates, see :ref:`templating`. (:class:`~sphinx.application.TemplateBridge`
is not supported.)
.. note::
If you find yourself spending much time tailoring the stub templates, this
may indicate that it's a better idea to write custom narrative documentation
instead.
Autosummary uses the following template files:
- :file:`autosummary/base.rst` -- fallback template
- :file:`autosummary/module.rst` -- template for modules
- :file:`autosummary/class.rst` -- template for classes
- :file:`autosummary/function.rst` -- template for functions
- :file:`autosummary/attribute.rst` -- template for class attributes
- :file:`autosummary/method.rst` -- template for class methods
The following variables available in the templates:
.. data:: name
Name of the documented object, excluding the module and class parts.
.. data:: objname
Name of the documented object, excluding the module parts.
.. data:: fullname
Full name of the documented object, including module and class parts.
.. data:: module
Name of the module the documented object belongs to.
.. data:: class
Name of the class the documented object belongs to. Only available for
methods and attributes.
.. data:: underline
A string containing ``len(full_name) * '='``.
.. data:: members
List containing names of all members of the module or class. Only available
for modules and classes.
.. data:: 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.
.. data:: classes
List containing names of "public" classes in the module. Only available for
modules.
.. data:: exceptions
List containing names of "public" exceptions in the module. Only available
for modules.
.. data:: methods
List containing names of "public" methods in the class. Only available for
classes.
.. data:: attributes
List containing names of "public" attributes in the class. Only available
for classes.
.. note::
You can use the :dir:`autosummary` directive in the stub pages.
Stub pages are generated also based on these directives.