==============
``documented``
==============

.. automodule:: documented

   .. contents::
      :local:

.. currentmodule:: documented


Functions
=========

- :py:func:`a_function`:
  This is the brief description of my function.


.. autofunction:: a_function


Classes
=======

- :py:class:`MyClass`:
  This is the brief of my main class.

- :py:class:`AnotherClass`:
  This another class.


.. autoclass:: MyClass

   .. rubric:: Inheritance
   .. inheritance-diagram:: MyClass
      :parts: 1
.. autoclass:: AnotherClass

   .. rubric:: Inheritance
   .. inheritance-diagram:: AnotherClass
      :parts: 1

Exceptions
==========

- :py:exc:`MyException`:
  This is my custom exception.


.. autoexception:: MyException

.. rubric:: Inheritance
   .. inheritance-diagram:: MyException
      :parts: 1

Variables
=========

- :py:data:`A_CONSTANT`
- :py:data:`YET_ANOTHER`

.. autodata:: A_CONSTANT
   :annotation:

   .. code-block:: text

      1000
.. autodata:: YET_ANOTHER
   :annotation:

   .. code-block:: text

      {'jam': 'eggs',
       'this': 'that',
       'yet': {'things': [1, 2, 3, 'a'], 'tuples': (1000, 4)}}