Source code for sphinx.addnodes

# -*- coding: utf-8 -*-
"""
    sphinx.addnodes
    ~~~~~~~~~~~~~~~

    Additional docutils nodes.

    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
"""

import warnings

from docutils import nodes


[docs]class toctree(nodes.General, nodes.Element): """Node for inserting a "TOC tree"."""
# domain-specific object descriptions (class, function etc.)
[docs]class desc(nodes.Admonition, nodes.Element): """Node for object descriptions. This node is similar to a "definition list" with one definition. It contains one or more ``desc_signature`` and a ``desc_content``. """
[docs]class desc_signature(nodes.Part, nodes.Inline, nodes.TextElement): """Node for object signatures. The "term" part of the custom Sphinx definition list. """
# nodes to use within a desc_signature
[docs]class desc_addname(nodes.Part, nodes.Inline, nodes.TextElement): """Node for additional name parts (module name, class name)."""
# compatibility alias desc_classname = desc_addname
[docs]class desc_type(nodes.Part, nodes.Inline, nodes.TextElement): """Node for return types or object type names."""
[docs]class desc_returns(desc_type): """Node for a "returns" annotation (a la -> in Python).""" def astext(self): return ' -> ' + nodes.TextElement.astext(self)
[docs]class desc_name(nodes.Part, nodes.Inline, nodes.TextElement): """Node for the main object name."""
[docs]class desc_parameterlist(nodes.Part, nodes.Inline, nodes.TextElement): """Node for a general parameter list.""" child_text_separator = ', '
[docs]class desc_parameter(nodes.Part, nodes.Inline, nodes.TextElement): """Node for a single parameter."""
[docs]class desc_optional(nodes.Part, nodes.Inline, nodes.TextElement): """Node for marking optional parts of the parameter list.""" child_text_separator = ', ' def astext(self): return '[' + nodes.TextElement.astext(self) + ']'
[docs]class desc_annotation(nodes.Part, nodes.Inline, nodes.TextElement): """Node for signature annotations (not Python 3-style annotations)."""
[docs]class desc_content(nodes.General, nodes.Element): """Node for object description content. This is the "definition" part of the custom Sphinx definition list. """
# new admonition-like constructs
[docs]class versionmodified(nodes.Admonition, nodes.TextElement): """Node for version change entries. Currently used for "versionadded", "versionchanged" and "deprecated" directives. """
[docs]class seealso(nodes.Admonition, nodes.Element): """Custom "see also" admonition."""
[docs]class productionlist(nodes.Admonition, nodes.Element): """Node for grammar production lists. Contains ``production`` nodes. """
[docs]class production(nodes.Part, nodes.Inline, nodes.TextElement): """Node for a single grammar production rule."""
# other directive-level nodes
[docs]class index(nodes.Invisible, nodes.Inline, nodes.TextElement): """Node for index entries. This node is created by the ``index`` directive and has one attribute, ``entries``. Its value is a list of 5-tuples of ``(entrytype, entryname, target, ignored, key)``. *entrytype* is one of "single", "pair", "double", "triple". *key* is categolziation characters (usually it is single character) for general index page. For the detail of this, please see also: :rst:dir:`glossary` and issue #2320. """
class centered(nodes.Part, nodes.TextElement): """Deprecated.""" class acks(nodes.Element): """Special node for "acks" lists.""" class hlist(nodes.Element): """Node for "horizontal lists", i.e. lists that should be compressed to take up less vertical space. """ class hlistcol(nodes.Element): """Node for one column in a horizontal list."""
[docs]class compact_paragraph(nodes.paragraph): """Node for a compact paragraph (which never makes a <p> node)."""
[docs]class glossary(nodes.Element): """Node to insert a glossary."""
[docs]class only(nodes.Element): """Node for "only" directives (conditional inclusion based on tags)."""
# meta-information nodes
[docs]class start_of_file(nodes.Element): """Node to mark start of a new file, used in the LaTeX builder only."""
[docs]class highlightlang(nodes.Element): """Inserted to set the highlight language and line number options for subsequent code blocks. """
class tabular_col_spec(nodes.Element): """Node for specifying tabular columns, used for LaTeX output."""
[docs]class meta(nodes.Special, nodes.PreBibliographic, nodes.Element): """Node for meta directive -- same as docutils' standard meta node, but pickleable. """
# inline nodes
[docs]class pending_xref(nodes.Inline, nodes.Element): """Node for cross-references that cannot be resolved without complete information about all documents. These nodes are resolved before writing output, in BuildEnvironment.resolve_references. """
class number_reference(nodes.reference): """Node for number references, similar to pending_xref."""
[docs]class download_reference(nodes.reference): """Node for download references, similar to pending_xref."""
[docs]class literal_emphasis(nodes.emphasis): """Node that behaves like `emphasis`, but further text processors are not applied (e.g. smartypants for HTML output). """
class literal_strong(nodes.strong): """Node that behaves like `strong`, but further text processors are not applied (e.g. smartypants for HTML output). """
[docs]class abbreviation(nodes.Inline, nodes.TextElement): """Node for abbreviations with explanations."""
[docs]class termsep(nodes.Structural, nodes.Element): """Separates two terms within a <term> node. .. versionchanged:: 1.4 sphinx.addnodes.termsep is deprecated. It will be removed at Sphinx-1.5. """ def __init__(self, *args, **kw): warnings.warn('sphinx.addnodes.termsep will be removed at Sphinx-1.5', DeprecationWarning, stacklevel=2) super(termsep, self).__init__(*args, **kw)
class manpage(nodes.Inline, nodes.TextElement): """Node for references to manpages.""" # make the new nodes known to docutils; needed because the HTML writer will # choke at some point if these are not added nodes._add_node_class_names(k for k in globals().keys() if k != 'nodes' and k[0] != '_')