Utilizo Sphinx para documentar un proyecto que no es de Python. Quiero distribuir carpetas ./doc en cada submódulo, que contengan archivos submodule_name.rst 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 módulos module1 docs module1.rst src module2 docs module2.rst src Intenté incluir archivos en el documento maestro project_spec.rst toctree así:
.. toctree:: :numbered: :max depth: 2 Módulo 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 usar ../ en la ruta de un documento de alguna manera?
Actualización: se agregó la 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/esfinge/problemas/701