Code Referencing

class ClassName

This is an example class

Is rendered from:

..  py:class:: ClassName
    :noindex:

    This is an example class

Which is composed of:

• sphinx.addnodes.index

• sphinx.addnodes.desc

  • sphinx.addnodes.desc_signature

    • sphinx.addnodes.desc_annotation

      • docutils.nodes.Text

    • sphinx.addnodes.desc_name

      • docutils.nodes.Text

  • sphinx.addnodes.desc_content

    • docutils.nodes.paragraph

      • docutils.nodes.Text

example_method()

This is an example method

Is rendered from:

.. py:method:: example_method
    :noindex:

    This is an example method

Which is composed of:

• sphinx.addnodes.index

• sphinx.addnodes.desc

  • sphinx.addnodes.desc_signature

    • sphinx.addnodes.desc_name

      • docutils.nodes.Text

    • sphinx.addnodes.desc_parameterlist

  • sphinx.addnodes.desc_content

    • docutils.nodes.paragraph

      • docutils.nodes.Text

example_attribute

This is an example attribute

Is rendered from:

.. py:attribute:: example_attribute
    :noindex:

    This is an example attribute

Which is composed of:

• sphinx.addnodes.index

• sphinx.addnodes.desc

  • sphinx.addnodes.desc_signature

    • sphinx.addnodes.desc_name

      • docutils.nodes.Text

  • sphinx.addnodes.desc_content

    • docutils.nodes.paragraph

      • docutils.nodes.Text