[PYTHON] Erste Schritte mit Sphinx. Generieren Sie Docstring mit Sphinx
Sphinx-Apidoc generiert automatisch Python Docstring Verwendet OSX 10.9.4. Verwendet Sphinx v1.1.3. Nach der Installation von Sphinx. Was tust du jetzt?
Verzeichnisaufbau
├── documents_source/
├── publish/
└── src/
└── main.py
main.py
# -*- coding: UTF-8 -*-
import sys
def main(name, age=None):
"""Greeting function.
:param name: Your name.
:param age: Youre age. (option)
"""
print "hello, " + name
if age is not None:
print "You are " + age
Erstellung von Dokumentenpapier
Führen Sie den Befehl sphinx-apidoc aus.
$ sphinx-apidoc -F -o ./documents_source ./src
Das obige ist nur zum ersten Mal. Generieren Sie eine vollständige Konfiguration mit der Option -F. Führen Sie dies ab dem zweiten Mal aus.
$ sphinx-apidoc -f -o ./documents_source ./src
Es gibt viele Dateien unter `` documents_source / ``. Dies ist die Quelle der generierten Dokumentation.
## Ermöglichen Sie den Import des Zielmoduls
Öffnen Sie `` documents_source / conf.py`` und bearbeiten und aktivieren Sie diesen auskommentierten Teil. Das Autodoc-Modul importiert und liest die Zieldatei, sodass Sie den Speicherort erfahren.
#### **` conf.py`**
```py
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../src'))
Dokumentausgabe
Führen Sie den Befehl sphinx-build aus.
$ sphinx-build -a ./documents_source ./publish
Überprüfen Sie, ob es als Dokument ausgegeben wird, das im Verzeichnis Publish / angezeigt werden kann.
Es wird wie folgt angezeigt.
Es ist einfacher zu verstehen, wenn Sie das offizielle Dokument lesen, nachdem Sie diesen Fluss unterdrückt haben. http://docs.sphinx-users.jp/index.html
Recommended Posts