在 Sphinx 中保持 API 更新
Keeping the API updated in Sphinx
方案如下。存在一个名为 foo 的包（API 正在大力开发，处于第一个 alpha 阶段）其 rst 文件是使用 sphinx-apidoc.
自动生成的
为了在生成这些文件后为 foo 提供更好的文档，进行了一些编辑。例如，在 foo.bar.rst 中，有一些段落添加到 sphinx-apidoc
生成的内容中
如何才能在对 sphinx-apidoc 进行新调用时不丢失所有这些信息？当然，我希望反映 API 中的潜在变化，同时保留添加的手册信息。
sphinx-apidoc只需要在你的项目模块结构发生变化时重新运行。如果添加、删除和重命名模块对您来说并不常见，那么最简单的方法可能是将第一个文件置于版本控制之下并手动更新它们。添加或删除模块只需要更改 rst 的几行，因此一旦 运行 一次，您甚至不需要使用 sphinx-apidoc。
方案如下。存在一个名为 foo 的包（API 正在大力开发，处于第一个 alpha 阶段）其 rst 文件是使用 sphinx-apidoc.
为了在生成这些文件后为 foo 提供更好的文档，进行了一些编辑。例如，在 foo.bar.rst 中，有一些段落添加到 sphinx-apidoc
如何才能在对 sphinx-apidoc 进行新调用时不丢失所有这些信息？当然，我希望反映 API 中的潜在变化，同时保留添加的手册信息。
sphinx-apidoc只需要在你的项目模块结构发生变化时重新运行。如果添加、删除和重命名模块对您来说并不常见，那么最简单的方法可能是将第一个文件置于版本控制之下并手动更新它们。添加或删除模块只需要更改 rst 的几行，因此一旦 运行 一次，您甚至不需要使用 sphinx-apidoc。