python - autoflask Sphinx 的摘要或目录

Question

我们使用 Sphinx 来记录我们的 Flask API。它做得很好，但我们在浏览它生成的文档时遇到了问题。

我们分别记录每个蓝图。我们的蓝图很大。每个大约有 1000 行长，我们的文档字符串非常详细。结果是一个列出端点的 Sphinx 页面，但是端点之间有太多的中间文档，很难理解该页面。在这里创建的正常内容是顶部的目录。我相信这里也可能需要 sphinx autosummary，但我不确定，因为我从未使用过它。

不幸的是，autosummary 不起作用，因为它似乎不是为处理与 autoflask (sphinxcontrib.autohttp.flask) 相同类型的输入而构建的。有谁知道告诉 sphinx 创建一个目录的方法，该目录创建页面内与 autoflask 兼容的所有成员的页面内链接？

Answer 1

原来在构建文件夹中生成了一个名为 http-routingtable.html 的 html 文件，它完成了我上面的要求。考虑到 sphinx(文档)的目的，您会认为这将被......记录在案......清楚。希望以后遇到此问题的其他人会看到这篇文章。