我正在使用Sphinx来记录非Python项目.我想./doc在每个子模块中分发文件夹,其中包含submodule_name.rst用于记录该模块的文件.然后我想将这些文件吸入主层次结构中,为整个设计创建一个规范.
即:
Project
docs
spec
project_spec.rst
conf.py
modules
module1
docs
module1.rst
src
module2
docs
module2.rst
src
我试图将文件包含在主project_spec.rst文档toctree中,如下所示:
.. toctree::
:numbered:
:maxdepth: 2
Module 1 <../../modules/module1/docs/module1>
但是,此错误消息导致:
警告:toctree包含对不存在的文档u'modules/module1/docs/module1'的引用
是不是可以以../某种方式在文档路径中使用？
更新:添加conf.py位置