我们假设我们的文档结构如下所示
.
|____src
| |____abc.py
|____docs
现在我们使用以下命令生成文档:
sphinx-apidoc -F -o docs src
这会在./docs/
文件夹中生成多个文件,包括一个./docs/abc.rst
,我现在可以使用make html
内的./docs/
来构建}文件夹。
现在,在./src/abc.py
中添加一些额外功能后,我想重建文档。我尝试了同样的事情,Sphinx说剩下的文件已经存在,因此它没有获得更新。 在更新文档之前,我必须手动删除相关文件。
现在问题是,如何在不必删除.rst
文件的情况下完成整个过程。
答案 0 :(得分:1)
sphinx-apidoc 有--force
选项可覆盖文件。
请参阅http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html#sphinx-apidoc-manual-page。