Ik gebruik Sphinx om een niet-Python-project te documenteren. Ik wil ./doc mappen distribueren in elke submodule, met daarin submodule_name.rst bestanden om die module te documenteren. Ik wil die bestanden vervolgens in de hoofdhiërarchie zuigen om een specificatie voor het hele ontwerp te maken.
Ie:
Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst src Ik heb geprobeerd om bestanden als volgt in het hoofddocument project_spec.rst op te nemen:
.. toctree:: :numbered: :maxdepth: 2 Module 1 < ;../../modules/module1/docs/module1> Dit foutbericht resulteert echter:
WAARSCHUWING: toctree bevat verwijzing naar niet-bestaand document u"modules/module1/docs/module1"
Is het niet mogelijk om ../ op de een of andere manier in een documentpad te gebruiken?
Update: Conf.py-locatie toegevoegd
Update : Afgezien van de onderstaande include-truc is dit nog steeds (2019) niet mogelijk. Er is een openstaande kwestie die steeds verder naar voren wordt geschoven: https://github.com/sphinx- doc/sphinx/issues/701