sphinx-autogen¶

Zusammenfassung¶

sphinx-autogen [Optionen] <Quelldatei> …

Beschreibung¶

sphinx-autogen ist ein Werkzeug zur automatischen Generierung von Sphinx-Quellen, die mit der autodoc-Erweiterung Elemente dokumentieren, die in autosummary-Listen enthalten sind.

Quelldatei ist der Pfad zu einem oder mehreren reStructuredText-Dokumenten, die autosummary-Einträge mit der Option :toctree: enthalten. Quelldatei kann ein Muster im fnmatch-Stil sein.

Optionen¶

-o <Ausgabeverzeichnis>¶: Verzeichnis, in dem die Ausgabedatei platziert werden soll. Wenn es nicht existiert, wird es erstellt. Standardmäßig der Wert, der an die Option :toctree: übergeben wurde.

-s <Suffix>, --suffix <Suffix>¶: Standard-Suffix für generierte Dateien. Standardmäßig rst.

-t <Vorlagen>, --templates <Vorlagen>¶: Benutzerdefiniertes Vorlagenverzeichnis. Standardmäßig None.

-i, --imported-members¶: Importierte Mitglieder dokumentieren.

-a, --respect-module-all¶: Genau die Mitglieder im Attribut __all__ eines Moduls dokumentieren.

--remove-old¶: Vorhandene Dateien im Ausgabeverzeichnis entfernen, die nicht mehr generiert werden.

Beispiel¶

Gegeben sei folgende Verzeichnisstruktur

docs
├── index.rst
└── ...
foobar
├── foo
│   └── __init__.py
└── bar
    ├── __init__.py
    └── baz
        └── __init__.py

Und angenommen, docs/index.rst enthielt Folgendes

Modules
=======

.. autosummary::
   :toctree: modules

   foobar.foo
   foobar.bar
   foobar.bar.baz

Wenn Sie Folgendes ausführen

$ PYTHONPATH=. sphinx-autogen docs/index.rst

Dann werden die folgenden Stub-Dateien in docs erstellt

docs
├── index.rst
└── modules
    ├── foobar.bar.rst
    ├── foobar.bar.baz.rst
    └── foobar.foo.rst

Und jede dieser Dateien enthält eine autodoc-Direktive und einige andere Informationen.

Siehe auch¶

sphinx-build(1), sphinx-apidoc(1)