autoflask sphinx的摘要或toc

时间:2015-05-07 08:10:31

标签: python documentation python-sphinx tableofcontents

我们使用sphinx来记录我们的烧瓶api。它做得非常好,但是我们在浏览它生成的文档时遇到了问题。我们分别记录每个蓝图。我们的蓝图非常大。每个长约1000行,我们的文档字符串非常详细。结果是一个列出端点的sphinx页面,但是在端点之间有如此多的介入文档,因此很难理解页面。在这里创建的正常事情是顶部的目录。我相信也可以在这里调用sphinx autosummary,虽然我不确定,因为我从未使用它。

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

2 个答案:

答案 0 :(得分:2)

原来有一个html文件,它在名为http-routingtable.html的构建文件夹中生成,它完成了我上面提到的问题。鉴于sphinx(文档)的目的,你会认为这将......记录清楚。希望将来遇到这个问题的其他人会遇到这个问题。

答案 1 :(得分:1)