在 Sphinx 文档期间覆盖 .rst 文件

Question

假设我们有一个如下所示的文档结构

.
|____src
| |____abc.py
|____docs

现在我们使用以下命令生成文档：

sphinx-apidoc -F -o docs src

这会在./docs/ 文件夹中生成几个文件，包括一个./docs/abc.rst，我现在可以在./docs/ 文件夹中使用make html 构建它。

现在，在./src/abc.py 中添加一些附加功能后，我想重建文档。我尝试了同样的事情，Sphinx 说其余文件已经存在，因此它没有得到更新。 我必须手动删除相关文件才能更新文档。

现在的问题是，我如何在不删除.rst 文件的情况下完成整个过程。

Answer 1

sphinx-apidoc 有一个 --force 选项用于覆盖文件。

见http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html#sphinx-apidoc-manual-page。