Sto usando Sphinx per documentare un progetto non Python. Voglio distribuire le cartelle ./doc
in ogni sottomodulo, contenenti i file submodule_name.rst
per documentare quel modulo. Voglio quindi risucchiare quei file nella gerarchia principale per creare una specifica per l'intero progetto.
Cioè:
Project docs spec project_spec.rst conf.py moduli module1 docs module1.rst src module2 docs module2.rst src
Ho tentato di includere file nel documento principale project_spec.rst
toctree in questo modo:
.. toctree:: :numbered: :maxdepth: 2 Modulo 1 < ;../../modules/module1/docs/module1>
Comunque risulta questo messaggio di errore:
ATTENZIONE: toctree contiene riferimenti a un documento inesistente u"modules/module1/docs/module1"
Non è possibile utilizzare ../
in un percorso del documento in qualche modo?
Aggiorna: aggiunta posizione conf.py
Aggiorna : A parte il trucco di inclusione di seguito, questo non è ancora possibile (2019). C'è un problema aperto che continua a essere portato avanti: https://github.com/sphinx- doc/sphinx/issues/701