Sphinx侧边栏:包括模块的函数和类的方法

时间:2019-10-21 12:44:41

标签: python-sphinx

在Sphinx文档中,我定义了这样的参考文档:

Reference
=========

.. toctree::

   reference_api
   reference_cli
   reference_client
   reference_downloads
   reference_options
   reference_stats
   reference_utils

reference_api文档如下所示:

API module
==========

.. automodule:: aria2p.api
    :no-members:

API
---

.. autoclass:: aria2p.api.API
    :members:

现在我在侧边栏中获得此列表:

Reference
  API module
    API

我还要在边栏中添加通过:members:记录的所有API方法,例如:

Reference
  API module
    API
      __init__
      add_magnet
      add_metalink
      ...

这可能吗?我应该改变Sphinx编写模块函数和类的方法以向其添加锚的方式,以便侧边栏可以显示它们吗?

0 个答案:

没有答案