python-sphinx
Dokumentstrings mit Autodoc schreiben

C++ CSS Django Flask Git HTML JavaScript latex MATLAB Language Python Language

Einführung

Sphinx ermöglicht die Aufnahme von Dokumentstrings in die Dokumentation mithilfe der im Lieferumfang enthaltenen Erweiterung autodoc . In dieser Dokumentation erfahren Sie, wie Sie Ihre Docstrings formatieren und in Ihre Dokumentation aufnehmen.

Installieren der Autodoc-Erweiterung

Fügen Sie den Autodoc Modul in den extensions list in der conf.py Datei im Stammverzeichnis Ihrer Dokumentation:

extensions = [
    'sphinx.ext.autodoc',
     ...
]

Hinzufügen Ihres Codepfads in der Sphinx-Konfiguration

Autodoc muss Ihre Module importieren, um funktionieren zu können.

Sie können Ihren conf.py in Ihre conf.py Datei aufnehmen.

Zum Beispiel:

import os
sys.path.insert(0, os.path.abspath('../src'))

Modified text is an extract of the original Stack Overflow Documentation

Lizenziert unter CC BY-SA 3.0

Nicht angeschlossen an Stack Overflow