diff options
| author | Georg Brandl <georg@python.org> | 2014-01-20 17:21:44 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2014-01-20 17:21:44 +0100 |
| commit | 883324fd6c61e60e7db563329ff9e27cd9652376 (patch) | |
| tree | 3c719fca66c0bb1b98027f69aa0226d44dad6faa /doc/extdev/nodes.rst | |
| parent | aecf35c1bd3bb2405e666d76761dbc92eb484da5 (diff) | |
| download | sphinx-git-883324fd6c61e60e7db563329ff9e27cd9652376.tar.gz | |
Doc: move API docs in their own chapter and add more of it.
Diffstat (limited to 'doc/extdev/nodes.rst')
| -rw-r--r-- | doc/extdev/nodes.rst | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/extdev/nodes.rst b/doc/extdev/nodes.rst new file mode 100644 index 000000000..e67fa3da6 --- /dev/null +++ b/doc/extdev/nodes.rst @@ -0,0 +1,57 @@ +.. _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 |
