【问题标题】:Summary or toc for autoflask Sphinxautoflask Sphinx 的摘要或目录
【发布时间】:2015-05-07 08:10:30
【问题描述】:

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

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

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

【问题讨论】:

    标签: python flask python-sphinx tableofcontents


    【解决方案1】:

    原来有一个 html 文件生成在名为 http-routingtable.html 的构建文件夹中,它可以满足我上面的要求。鉴于狮身人面像(文档)的目的,您会认为这将被......记录在案......清楚地。希望以后遇到此问题的其他人会遇到此帖子。

    【讨论】:

      【解决方案2】:

      【讨论】:

        猜你喜欢
        • 2021-05-07
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2012-08-25
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多