python - 无法让狮身人面像在 toctree 下链接到另一个文档

Question

我正在尝试学习 sphinx 并且只停留在基本示例上。我在源目录中的 make html 中收到以下错误。

Running Sphinx v1.1.3
loading pickled environment... not yet created
building [html]: targets for 2 source files that are out of date
updating environment: 2 added, 0 changed, 0 removed
reading sources... [100%] intro                                                 
/home/owner/Desktop/doc/index.rst:11: ERROR: Error in "toctree" directive:
invalid option block.

.. toctree::
   :maxdepth: 2
   intro.rst
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/owner/Desktop/doc/intro.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] intro                                                  
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 2 warnings.

Build finished. The HTML pages are in _build/html.

我还尝试引用 intro 而不是 intro.rst 似乎都不起作用。 index.rst 和 intro.rst 在同一个目录下。我使用 sphinx-quickstart 和所有默认选项创建了项目。

Answer 1

您需要在指令的选项和它的内容之间有一个空行。您也不需要文件扩展名。将其更改为:

.. toctree::
   :maxdepth: 2

   intro