在 Sphinx 中保持 API 更新

Question

方案如下。有一个名为foo（正在大力开发的 API，处于第一个 alpha 阶段）的包，其rst文件是使用sphinx-apidoc.

为了在foo生成这些文件后有更好的文档，需要进行一些编辑。比如说，foo.bar.rst在生成的内容中添加了一些段落sphinx-apidoc

sphinx-apidoc当进行新的呼叫时，如何才能不丢失所有这些信息？当然，我希望反映 API 中的潜在更改，并保留添加的手动信息。

Answer 1

sphinx-apidoc仅当项目的模块结构发生变化时才需要重新运行。如果添加、删除和重命名模块对您来说并不常见，那么最简单的方法可能是将第一个文件置于版本控制之下并手动更新它们。sphinx-apidoc添加或删除模块只需要更改第一行的几行，因此一旦运行一次就不需要使用。