Estoy usando Sphinx para documentar un proyecto que no es de Python. Quiero distribuir ./doc
carpetas en cada submódulo, que contienen submodule_name.rst
archivos para documentar ese módulo. Luego quiero absorber esos archivos en la jerarquía maestra para crear una especificación para todo el diseño.
Es decir:
Project
docs
spec
project_spec.rst
conf.py
modules
module1
docs
module1.rst
src
module2
docs
module2.rst
src
project_spec.rst
Intenté incluir archivos en el documento maestro en un árbol como este:
.. toctree::
:numbered:
:maxdepth: 2
Module 1 <../../modules/module1/docs/module1>
Sin embargo, este mensaje de error resulta:
ADVERTENCIA: toctree contiene una referencia a un documento no existente u'modules / module1 / docs / module1 '
¿No es posible usarlo ../
en una ruta de documento de alguna manera?
Actualización: agregada ubicación conf.py
Actualización: Aparte del truco de inclusión a continuación, esto todavía (2019) no es posible. Hay un problema abierto que sigue avanzando: https://github.com/sphinx-doc/sphinx/issues/701
.rst
extensión a la líneaModule 1 <../../modules/module1/docs/module1>
?