Sphinx-Apidoc-Nutzung - mehrere Quellen Python-Verzeichnisse - Python, Dokumentation, Python-Sphinx

Also habe ich meine Python-Quelldateien in zwei verschiedenen Verzeichnissen:

z.B.

~/work/myproject
~/.virtualenvs/myproject

Wie verwende ich? sphinx-apidoc in beiden Verzeichnissen rekursiv nach meinen reST-Dateien zu suchen?

Offensichtlich,

sphinx-apidoc -o docs/source ~/work/myproject

funktioniert ganz gut, aber wenn ich versuche zu laufen

sphinx-apidoc -o docs/source ~/.virtualenvs/myproject

wieder sagt mir sphinx, dass "docs / source / modules.rst bereits existiert, skipping" was natürlich wahr ist wie ich es schon gemacht habe sphinx-apidoc einmal um es zu generieren.

Also wie führe ich es einmal aus und suche in beiden Verzeichnissen?

Antworten:

1 für die Antwort № 1

Entsprechend der Sphinx apidoc Dokumentation, die Befehlszeilensyntax lautet:

sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames ...]

Update: falsch, siehe Kommentar von @jgbarah unten.

Dies bedeutet, dass Sie, wenn Sie Quellen in zwei separaten Verzeichnissen dokumentieren möchten kann Übergeben Sie beide Verzeichnisse / Pfadnamen gleichzeitig, so etwas wie:

sphinx-apidoc -o docs/source ~/work/myproject ~/.virtualenvs/myproject

Verbesserter Vorschlag:

Sie können in Ihrer Dokumentation pro Projekt ein Unterverzeichnis erstellen. So etwas wie:

sphinx-apidoc -o docs/source/app1 ~/work/myproject1
sphinx-apidoc -o docs/source/app2 ~/work/myproject2

Mit einem Baum können Sie dann auf die zwei Unterverzeichnisse zeigen:

.. toctree::
:maxdepth: 2

app1/index.rst
app2/index.rst

---