Estou usando o Sphinx para documentar um projeto não Python. Eu quero distribuir as pastas ./doc em cada submódulo, contendo arquivos submodule_name.rst para documentar aquele módulo. Eu então quero sugar esses arquivos para a hierarquia mestre para criar uma especificação para todo o design.
Isto:
Documentos do projeto spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst src Tentei incluir arquivos no documento mestre project_spec.rst toctree assim:
.. toctree:: :numbered: :maxdepth: 2 Module 1 < ;../../modules/module1/docs/module1> No entanto, esta mensagem de erro resulta:
AVISO: toctree contém referência a um documento inexistente u"modules/module1/docs/module1"
Não é possível usar ../ em um caminho de documento de alguma forma?
Atualização: Adicionada localização do conf.py
Atualização : Além do truque de inclusão abaixo, isso ainda (2019) não é possível. Há um problema em aberto que continua sendo adiado: https://github.com/sphinx- doc/sphinx/issues/701