微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

python-sphinx自动摘要目录

如何解决python-sphinx自动摘要目录

我正在尝试使用sphinx.ext.autosummary扩展来记录我的包裹。

index.rst 中,我有

.. toctree::
    :maxdepth: 20
    :caption: References

    reference

reference.rst 中:

=============
API Reference
=============

.. autosummary::
    :recursive:
    :toctree: _api_reference

    mypackage

在参考的第一页上,它创建了一个链接表,其中仅包含我的包裹的一个条目。 我也想在首页上列出模块列表(就像auto-api扩展一样)。 我可以在 reference.rst 中插入toctree指令,但是在这种情况下,我在侧边栏菜单中有两次子模块链接,并且在链接表中有一个名称参考文件的第一页以及此后的目录再次具有相同的包名称

是否有某种方法可以在自动摘要生成的API参考的首页上放置带有包名称和模块列表的目录?

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。