Weitere Direktiven

reStructuredText kann mit Directives erweitert werden. Sphinx macht hiervon ausgiebig Gebrauch. Hier sind einige Beispiele:

Inhaltsverzeichnis

• Erstellt ein Sphinx-Projekt
  • Installation und Start
  • Sphinx-Layout
  • Generiert die Dokumentation
• Docstrings
  • .. automodule::
  • .. autoclass::
  • .. autoefunction::
  • Installation
  • Beispiele
  • sphinx-autodoc-typehints
  • sphinx.ext.napoleon

.. toctree::
   :maxdepth: 2

   start
   docstrings

Meta-Informationen

Autor des Abschnitts: Veit Schiele <veit@cusy.io>

Autor des Quellcode: Veit Schiele <veit@cusy.io>

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

Bemerkung

Standardmäßig wird diese Angabe nicht in der Ausgabe berücksichtigt, bis ihr die Konfiguration für show_authors auf True setzt.

Siehe auch

Siehe auch

Sphinx Directives

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

Glossar

Environment

Eine Struktur, in der Informationen über alle Dokumente unterhalb des Stammverzeichnisses gespeichert und für Querverweise verwendet werden. Die Umgebung wird gespeichert, so dass nachfolgende Programmläufe nur neue und geänderte Dokumente lesen und parsen.

Quellverzeichnis

Das Verzeichnis, das einschließlich seiner Unterverzeichnisse alle Quelldateien für ein Sphinx-Projekt enthält.

.. glossary::

   Environment
       Eine Struktur, in der Informationen über alle Dokumente unterhalb des
       Stammverzeichnisses gespeichert und für Querverweise verwendet werden.
       Die Umgebung wird gespeichert, so dass nachfolgende Programmläufe nur
       neue und geänderte Dokumente lesen und parsen.

   Quellverzeichnis
       Das Verzeichnis, das einschließlich seiner Unterverzeichnisse alle
       Quelldateien für ein Sphinx-Projekt enthält.