python - 在一个 python 文件上运行 Sphinx 的最简单方法

Question

我们有一个 Sphinx 配置，可以为我们的整个代码库生成大量 HTML 文档。有时，我正在处理一个文件，我只想查看该文件的 HTML 输出，以确保语法正确，而无需运行整个套件。

我寻找可以在终端中运行的最简单的命令来在这个文件上运行 sphinx，我确信信息在那里，但我没有看到它。

Answer 1

Sphinx 处理 reST 文件(不是直接处理 Python 文件)。这些文件可能包含对 Python 模块的引用(当您使用 autodoc 时)。我的经验是，如果自上次完整输出构建以来仅修改了一个 Python 模块，Sphinx 不会重新生成所有内容；仅处理“引入”该特定 Python 模块的 reST 文件。有一条消息说 updating environment: 0 added, 1 changed, 0 removed。

要显式处理单个 reST 文件，请将其指定为 sphinx-build 的参数:

sphinx-build -b html -d _build/doctrees . _build/html your_filename.rst