Я использую Sphinx для документирования не-Python проекта. Я хочу распространять папки ./doc
в каждом подмодуле, содержащие файлы submodule_name.rst
для документирования этого модуля. Затем я хочу добавить эти файлы в основную иерархию, чтобы создать спецификацию для всего проекта.
т.е.:
Project
docs
spec
project_spec.rst
conf.py
modules
module1
docs
module1.rst
src
module2
docs
module2.rst
src
Я попытался включить файлы в главный документ project_spec.rst
, например так:
.. 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