Question

如何在底部修复Sphinx的警告？

我想在Sphinx中获取我的Python笔记。我将我的笔记放在与 index.rst 相同的目录级别的单独文件中。

构建HTML

后，我收到以下警告

警告

/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree

在

构建时的完整消息

sudo sphinx-build -b html ./ _build/html
Running Sphinx v0.6.2
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 1 added, 2 changed, 0 removed
reading sources... [100%] trig_functions
/home/heo/S_codes/databooklet.rst:1: (WARNING/2) malformed hyperlink target.
/home/heo/S_codes/index.rst:11: (ERROR/3) Error in "toctree" directive:
invalid option block.

.. toctree::
   :numbered:
   :glob:
   *
   databooklet.rst
   trig_functions.rst


/home/heo/S_codes/trig_functions.rst:11: (ERROR/3) Unexpected indentation.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/heo/S_codes/databooklet.rst:: WARNING: document isn't included in any toctree
/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] trig_functions
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 6 warnings.

Answer 1

您是否了解Sphinx的文档？ http://sphinx.pocoo.org/contents.html

具体来说，请阅读toctree指令：http://sphinx.pocoo.org/concepts.html

您可以拥有任意数量的文件。通过toctree，您可以从许多部分创建单个文档。

请实际上阅读：http://sphinx.pocoo.org/concepts.html#document-names

因为reST源文件可以有   不同的扩展（有些人喜欢   .txt，有些像.rst - 扩展名   可以配置source_suffix）   不同的操作系统有不同的路径   分离器，狮身人面像抽象它们：全部   “文件名”是相对的   源目录，扩展名是   剥离和路径分隔符   转换为斜杠。所有价值观，   参数等等   “文件”期望这样的文件   名。

文档名称的示例是index，   library/zipfile，或   reference/datamodel/types。注意   没有领先的斜线。

由于您使用*进行了全局操作，因此无需列出文件。

如果您要列出文件，请实际上阅读并按照上述规则。

狮身人面像的位置来源于我的笔记

1 个答案: