我正在尝试开始使用 Sphinx 来记录 Python,但我似乎缺少一些非常基本的入门步骤。
我正在关注http://www.sphinx-doc.org/en/stable/tutorial.html并已安装并配置(尽可能使用默认值)该工具。
问题是我无法将另一个 RST 文件链接到索引。我的索引文件如下:
Welcome to FirstProject's documentation!
====================================
.. toctree::
:maxdepth: 2
intro
请注意,intro.rst 位于同一目录中,内容如下:
Introduction to the FirstProject project!!
======================================
.. toctree::
:maxdepth: 2
输出类型为html。当我尝试时
make html
我收到一条警告:
/home/ngk/Code/Projects/Twitter/botscore/doc/intro.rst: WARNING: document isn't included in any toctree
我期望在 index.html 中创建带有“intro”字符串的超链接,该链接指向 intro.html
相反,index.html 文件中的预期位置只有一个字符串“intro”。请注意,创建了 intro.html 文件,但未创建来自 index.html 的超链接
有人可以建议我错过了看似很小的一步吗?
看起来问题在于 Sphinx-doc 期望所包含的 RST 的每行开头有 3 个空格。如下更改我的 index.rst 解决了问题!
.. toctree::
:maxdepth: 2
intro
Sphinx-doc 似乎对空格的确切数量很敏感。我尝试使用较少的数量,也尝试使用制表符空间,但都不起作用。
希望这对遇到此问题的其他人有用。
Edit:它也适用于其他数量的空格,只要八叉树中的每个条目具有相同数量的空格即可。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)