Georg Brandl avatar Georg Brandl committed 976fc6a

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

Comments (0)

Files changed (1)

doc/ext/autosummary.rst

             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
 --------------------------------------------------------
 
    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.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.