在Sphinx中保持API的更新

Question

该计划如下。有一个名为foo的包(最初处于高度开发阶段的API )，其rst文件由sphinx-apidoc自动生成。

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

当发出新的sphinx-apidoc调用时，我如何才能不泄露所有这些信息呢？当然，我希望API中的潜在更改能够得到反映，并保留这些手动信息。

Answer 1

只有当项目的模块结构发生变化时，才需要重新运行sphinx-apidoc。如果添加、删除和重命名模块对您来说并不常见，那么只需将rst文件置于版本控制之下并手动更新它们可能是最容易的。添加或删除一个模块只需要更改几行rst，所以在运行一次之后甚至不需要使用sphinx-apidoc。