0

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

.
|____src
| |____abc.py
|____docs

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

sphinx-apidoc -F -o docs src

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

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

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

4

1 回答 1

3

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

请参阅http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html#sphinx-apidoc-manual-page

于 2017-05-17T06:50:11.760 回答