Я использую Sphinx для документирования проекта, отличного от Python. Я хочу распределить папки ./doc в каждом подмодуле, содержащие файлы submodule_name.rst для документирования этого модуля. Затем я хочу вставить эти файлы в основную иерархию, чтобы создать спецификацию для всего проекта.
То есть:
Спецификация документации проекта project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst src Я попытался включить файлы в главный документ project_spec.rst toctree следующим образом:
.. toctree:: :numbered: :maxdepth: 2 Module 1 < ;../../modules/module1/docs/module1> Однако возникает следующее сообщение об ошибке:
ВНИМАНИЕ: toctree содержит ссылку на несуществующий документ u"modules/module1/docs/module1"
Нельзя ли как-то использовать ../ в пути к документу?
Обновление: добавлено местоположение conf.py
Обновление : За исключением приведенного ниже трюка с включением, это все еще (2019) невозможно. Существует открытая проблема, которая постоянно продвигается вперед: https://github.com/sphinx- doc/sphinx/issues/701