Directives

reStructuredText can be expanded with Directives. Sphinx makes extensive use of this. Here are some examples:

Table of Contents

• Create a Sphinx project
  • Installation and start
  • Sphinx layout
  • Generate the documentation
• Docstrings
  • .. automodule::
  • .. autoclass::
  • .. autoexception::
  • Installation
  • Examples
  • sphinx-autodoc-typehints
  • sphinx.ext.napoleon

.. toctree::
   :maxdepth: 2

   start
   docstrings

Meta information

Section author: Veit Schiele <veit@cusy.io>

Code author: Veit Schiele <veit@cusy.io>

.. sectionauthor:: Veit Schiele <veit@cusy.io>
.. codeauthor:: Veit Schiele <veit@cusy.io>

Note

By default, this information is not included in the output until you set the configuration for show_authors to True.

See also

See also

Sphinx Directives

.. seealso::
    `Sphinx Directives
    <https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html>`_

Glossary

environment

A structure where information about all documents under the root is saved, and used for cross-referencing. The environment is pickled after the parsing stage, so that successive runs only need to read and parse new and changed documents.

source directory

The directory which, including its subdirectories, contains all source files for one Sphinx project.

.. glossary::

   environment
       A structure where information about all documents under the root is
       saved, and used for cross-referencing.  The environment is pickled
       after the parsing stage, so that successive runs only need to read
       and parse new and changed documents.

   source directory
       The directory which, including its subdirectories, contains all
       source files for one Sphinx project.