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 (将#修改为@)