我正在使用 Sphinx 来记录一个非 Python 项目。我要分发./doc
每个子模块中的文件夹,包含submodule_name.rst
文件来记录该模块。然后,我想将这些文件吸收到主层次结构中,为整个设计创建规范。
I.e.:
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 包含对不存在的文档模块/模块 1/docx/模块 1' 的引用
是不是不能使用../
以某种方式在文档路径中?
更新:添加了conf.py位置
更新:
除了下面的包含技巧之外,这仍然是(2019)不可能的。有一个悬而未决的问题不断被推进:https://github.com/sphinx-doc/sphinx/issues/701
是的你可以!
代替符号链接(在 Windows 上不起作用),创建一个存根文档,其中除了.. include::
指示。
我在尝试链接到源树顶部的自述文件时遇到了这个问题。我将以下内容放入一个名为的文件中readme_link.rst
:
.. include:: ../README
Then in index.rst
,我使 toctree 看起来像:
Contents:
.. toctree::
:maxdepth: 2
readme_link
other_stuff
现在我的索引页上有一个指向我的发行说明的链接。
谢谢http://reinout.vanrees.org/weblog/2010/12/08/include-external-in-sphinx.html对于建议
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)