Боковая панель Sphinx: включает функции модуля и методы класса - PullRequest
Новая
       33

Боковая панель Sphinx: включает функции модуля и методы класса

1 голос
/ 21 октября 2019

В документах 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

Я хотел бы также добавить все методы API, которые были задокументированы с помощью :members: на боковой панели, что-то вроде: 

Reference
  API module
    API
      __init__
      add_magnet
      add_metalink
      ...

Возможно ли это? Должен ли я изменить способ, которым Sphinx записывает функции модулей и методы классов, чтобы добавить к ним привязки, чтобы боковая панель могла их отображать?

...