Python 在Sphinx中保持API的更新

计划如下。存在一个名为

foo

的包（一个正在大力开发的API，处于第一个alpha阶段），其

rst

文件由

sphinx-apidoc

自动生成

为了在生成这些文件后为

foo

提供更好的文档，需要进行一些编辑。例如，在

foo.bar.rst

中，使用

sphinx apidoc生成的内容中添加了一些段落

当新调用
sphinx-apidoc
时，我怎么能不丢失所有这些信息呢？当然，我希望API中的潜在更改得到反映，并保留添加的手动信息。
sphinx apidoc
只有在项目的模块结构发生更改时才需要重新运行。如果添加、删除和重命名模块对您来说并不常见，那么将rst文件置于版本控制下并手动更新可能是最简单的方法。添加或删除一个模块只需要更改几行rst，所以运行一次之后，您甚至不需要使用
sphinx apidoc
。
在我的一个项目（使用git）中，我有一个单独的孤立分支来跟踪所有与sphinx相关的更改。然后，每当我们需要生成html文档时，我就从master分支，并将sphinx分支合并到。这样，所有与sphinx相关的更改都会进行版本控制，并避免因正在进行的工作而导致的任何过度写入。