J'utilise Sphinx pour documenter un projet non-Python. Je souhaite distribuer des dossiers ./doc
dans chaque sous-module, contenant des fichiers submodule_name.rst
pour documenter ce module. Je veux ensuite aspirer ces fichiers dans la hiérarchie principale pour créer une spécification pour l'ensemble de la conception.
Par exemple :
Spécification de la documentation du projet project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst src
J'ai essayé d'inclure des fichiers dans le document maître project_spec.rst
toctree comme ceci :
.. toctree :: :numbered: :maxdepth: 2 Module 1 < ;../../modules/module1/docs/module1>
Cependant, ce message d'erreur résulte :
ATTENTION : toctree contient une référence au document inexistant u"modules/module1/docs/module1"
N'est-il pas possible d'utiliser ../
dans un chemin de document d'une manière ou d'une autre ?
Mise à jour : Ajout de l'emplacement conf.py
Mise à jour : Autre que l'astuce d'inclusion ci-dessous, ce n'est toujours pas (2019) possible. Il y a un problème ouvert qui ne cesse d'être avancé : https://github.com/sphinx- doc/sphinx/issues/701