Sphinx autosummary如何在当前页生成模块表格而非新页面?
解决Sphinx autosummary表格直接显示在当前页面的问题
要让autosummary生成的模块表格直接显示在当前页面而非跳转链接,核心是移除:toctree:配置项——这个选项正是用来生成独立页面并创建跳转链接的。
修改后的mypage.rst内容如下:
.. currentmodule:: package .. autosummary:: :recursive: module
关键说明:
- 去掉
:toctree: generated后,autosummary会直接在当前页面渲染模块的摘要表格,不再生成generated目录下的独立页面。 :recursive:选项仍可保留,它会递归展示目标模块下的所有子模块,但所有内容都会内联在当前页面中。- 如果需要展示模块内的成员(如函数、类),可以添加
:members:选项来扩展显示内容,示例:.. autosummary:: :recursive: :members: module
内容的提问来源于stack exchange,提问作者tanglef
相关产品推荐
相关产品推荐

