Sphinx，保持API更新

Question

该计划如下。存在一个名为foo的包（在重大开发中处于初始alpha阶段的API），其rst个文件是使用sphinx-apidoc自动生成的。

为了在生成这些文件后为foo提供更好的文档，可以进行一些编辑。例如，foo.bar.rst在使用sphinx-apidoc

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

如果拨打sphinx-apidoc的新电话，我怎能不丢失所有信息？当然，我希望能够反映API中的潜在变化，同时保留添加的手动信息。

感谢您的时间。

Answer 1

只有在项目的模块结构发生变化时才需要重新运行

sphinx-apidoc。如果添加，删除和重命名模块对您而言并不常见，最简单的方法是将第一个文件置于版本控制之下并手动更新。添加或删除模块只需更改几行rst，因此一旦运行一次，您甚至不需要使用sphinx-apidoc。