我正在使用 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:: :numbered: :maxdepth: 2 Module 1 < ;../../modules/module1/docs/module1>
但是這個錯誤消息的結果是:
警告:toctree 包含對不存在的文檔 u"modules/module1/docs/module1" 的引用
難道不能以某種方式在文檔路徑中使用 ../
嗎?
更新:添加 conf.py 位置
更新:除了下面的包含技巧之外,這仍然是(2019)不可能的。有一個未解決的問題不斷被推進:https://github.com/sphinx- doc/sphinx/issues/701