Sphinx:为每个方法创建toc条目



我使用sphinx-autodoc来记录一个类。我希望类的方法对应于Sphinx TOC中的各个条目,以便它们在"本地TOC"侧栏中生成一个链接。

我怎样才能做到这一点?

AFAICT,autoclass指令不支持此操作。我试图使用autosummary,但我也不能让那一个工作:它想要单独的.rst文件中的个别方法。我宁愿把它们都放在一个页面上。

我想我可以为每个成员手工创建一个section,像这样:

Foo.bar()
---------
.. automethod:: Foo.bar

但这感觉很奇怪,而且不必要的复杂。

我编写了一个名为autoclasstoc的sphinx插件,它的功能与您想要的类似。该插件提供了一个指令,该指令为特定类的每个方法创建一个指向文档的链接表。这些链接不会出现在TOC侧边栏中,但它们仍然使类文档更容易导航。值得一提的是,这些链接可以组织成组(例如,公共方法,私有方法等),并且继承方法的链接按超类分组,默认情况下折叠。

尽管这并不能完全回答你的问题,但这是达到类似效果的好方法。

最新更新