Używam Sphinxa do dokumentowania projektu innego niż Python. Chcę dystrybuować foldery ./doc w każdym module podrzędnym, zawierające pliki nazwa_modułu.rst w celu udokumentowania tego modułu. Następnie chcę wessać te pliki do głównej hierarchii, aby stworzyć specyfikację dla całego projektu.
Np.:
Specyfikacja dokumentacji projektowej project_spec.rst moduły conf.py moduł1 dokumentacja moduł1.rst src moduł2 dokumentacja moduł2.rst src Próbowałem dołączyć pliki do głównego project_spec.rst dokumentu toctree w następujący sposób:
.. toctree:: :numbered: :maxdepth: 2 Moduł 1 < ;../../moduły/moduł1/docs/moduł1> Jednak ten komunikat o błędzie skutkuje:
OSTRZEŻENIE: toctree zawiera odniesienie do nieistniejącego dokumentu u"moduły/moduły1/docs/moduł1"
Czy nie można w jakiś sposób użyć ../ w ścieżce dokumentu?
Aktualizacja: Dodano lokalizację conf.py
Aktualizuj : Poza sztuczką z dołączaniem poniżej, to nadal (2019) nie jest możliwe. Istnieje otwarty problem, który wciąż się rozwija: https://github.com/sphinx- doc/sphinx/issues/701