Ich verwende Sphinx, um ein Nicht-Python-Projekt zu dokumentieren. Ich möchte ./doc-Ordner in jedem Submodul verteilen, die submodule_name.rst-Dateien enthalten, um dieses Modul zu dokumentieren. Ich möchte diese Dateien dann in die Master-Hierarchie saugen, um eine Spezifikation für das gesamte Design zu erstellen.
Bsp.:
Projektdokumentation spec project_spec.rst conf.py module module1 docs module1.rst src module2 docs module2.rst src Ich habe versucht, Dateien in das Hauptdokument project_spec.rst wie folgt einzufügen:
.. toctree:: :numbered: :maxdepth: 2 Modul 1 < ;../../modules/module1/docs/module1> Trotzdem ergibt sich diese Fehlermeldung:
WARNUNG: toctree enthält Verweis auf nicht vorhandenes Dokument u"modules/module1/docs/module1"
Ist es nicht möglich, ../ irgendwie in einem Dokumentpfad zu verwenden?
Update: conf.py-Speicherort hinzugefügt
Update : Abgesehen von dem Include-Trick unten ist dies immer noch (2019) nicht möglich. Es gibt ein offenes Problem, das immer weiter vorangetrieben wird: https://github.com/sphinx- doc/sphinx/issues/701