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

Document autosummary template variable "objtype" (#11044)

Browse Source
This commit is contained in:
Tim Hoffmann
2023-01-02 19:38:17 +01:00
committed by GitHub
parent 94e6e3917f
commit ec26c2f874
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/usage/extensions/autosummary.rst
View File

@@ -271,6 +271,12 @@ The following variables are available in the templates:
Full name of the documented object, including module and class parts.
.. data:: objtype
Type of the documented object, one of ``"module"``, ``"function"``,
``"class"``, ``"method"``, ``"attribute"``, ``"data"``, ``"object"``,
``"exception"``, ``"newvarattribute"``, ``"newtypedata"``, ``"property"``.
.. data:: module
Name of the module the documented object belongs to.