不能让sphinx在toctree下链接到另一个文档

时间:2012-09-14 14:24:33

标签: python documentation python-sphinx restructuredtext

我正在尝试学习狮身人面像,而且我只是坚持基本的例子。我在源目录中的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.rstintro.rst位于同一目录中。我使用sphinx-quickstart和所有默认选项创建了项目。

1 个答案:

答案 0 :(得分:9)

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

.. toctree::
   :maxdepth: 2

   intro