Von epydoc zu sphinx wechseln, um eine einfache Python-.py-Datei automatisch zu dokumentieren

Question

Epydoc funktioniert nicht mehr, selbst nach dem Anwenden von Patches, also versuche ich, zu Sphinx zu wechseln.

mag ich automatisch generieren Dokumentation aus einer einfachen Python-Datei: test.py

Nach der Installation und Ausführung Sphinx-Schnellstart-Skript I test.py zum Quelle Ordner kopiert und tippt:..

Sphinx-build -b html \ source \ bauen

Aber es produziert nur die minimiun HTML-Dateien, und es analysiert keine der test.py Datei

ich die Ideen ausgehen.

Vielen Dank für Ihre Hilfe :)

Answer 1

Sie haben sphinx.ext.autodoc als Erweiterung enthalten in Ihrem conf.py (http://sphinx.pocoo.org/config.html#confval-extensions), als Sie das Modul mit der .. automodule:: Richtlinie (oder Objekte aus diesem Modul mit .. autoclass::, dokumentieren .. autofunction::, ...).

Siehe http://sphinx.pocoo.org/ext/autodoc.html

Answer 2

Für Auto-Erzeugung der notwendigen .rst Dateien sphinx-apidoc verwenden können.

Das macht das Leben viel einfacher. Sie müssen also nicht jedes Ihrer Module manuell dokumentieren.