mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
58 lines
1.2 KiB
ReStructuredText
58 lines
1.2 KiB
ReStructuredText
|
.. _nodes:
|
||
|
|
|
||
|
|
Doctree node classes added by Sphinx
|
||
|
|
====================================
|
||
|
|
|
||
|
|
.. module:: sphinx.addnodes
|
||
|
|
|
||
|
|
Nodes for domain-specific object descriptions
|
||
|
|
---------------------------------------------
|
||
|
|
|
||
|
|
.. autoclass:: desc
|
||
|
|
.. autoclass:: desc_signature
|
||
|
|
.. autoclass:: desc_addname
|
||
|
|
.. autoclass:: desc_type
|
||
|
|
.. autoclass:: desc_returns
|
||
|
|
.. autoclass:: desc_name
|
||
|
|
.. autoclass:: desc_parameterlist
|
||
|
|
.. autoclass:: desc_parameter
|
||
|
|
.. autoclass:: desc_optional
|
||
|
|
.. autoclass:: desc_annotation
|
||
|
|
.. autoclass:: desc_content
|
||
|
|
|
||
|
|
New admonition-like constructs
|
||
|
|
------------------------------
|
||
|
|
|
||
|
|
.. autoclass:: versionmodified
|
||
|
|
.. autoclass:: seealso
|
||
|
|
|
||
|
|
Other paragraph-level nodes
|
||
|
|
-------------------------------
|
||
|
|
|
||
|
|
.. autoclass:: compact_paragraph
|
||
|
|
|
||
|
|
New inline nodes
|
||
|
|
----------------
|
||
|
|
|
||
|
|
.. autoclass:: index
|
||
|
|
.. autoclass:: pending_xref
|
||
|
|
.. autoclass:: literal_emphasis
|
||
|
|
.. autoclass:: abbreviation
|
||
|
|
.. autoclass:: download_reference
|
||
|
|
|
||
|
|
Special nodes
|
||
|
|
-------------
|
||
|
|
|
||
|
|
.. autoclass:: only
|
||
|
|
.. autoclass:: meta
|
||
|
|
.. autoclass:: highlightlang
|
||
|
|
|
||
|
|
You should not need to generate the nodes below in extensions.
|
||
|
|
|
||
|
|
.. autoclass:: glossary
|
||
|
|
.. autoclass:: toctree
|
||
|
|
.. autoclass:: start_of_file
|
||
|
|
.. autoclass:: productionlist
|
||
|
|
.. autoclass:: production
|
||
|
|
.. autoclass:: termsep
|