在一个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