J'utilise Sphinx pour documenter un projet non Python. Je souhaite distribuer des ./doc
dossiers dans chaque sous-module, contenant des submodule_name.rst
fichiers 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.
C'est à dire:
Project
docs
spec
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 project_spec.rst
toctree du document maître comme ceci:
.. toctree::
:numbered:
:maxdepth: 2
Module 1 <../../modules/module1/docs/module1>
Cependant, ce message d'erreur se produit:
ATTENTION: toctree contient une référence à un document non existant u'modules / module1 / docs / module1 '
N'est-il pas possible d'utiliser ../
d'une manière ou d'une autre dans un chemin de document?
Mise à jour: ajout de l'emplacement conf.py
Mise à jour: autre que l'astuce d'inclusion ci-dessous, cela n'est toujours pas possible (2019). Il y a un problème ouvert qui ne cesse de progresser: https://github.com/sphinx-doc/sphinx/issues/701
.rst
extension à la ligneModule 1 <../../modules/module1/docs/module1>
?