Подтвердить что ты не робот

Sphinx: список функций в модуле

У меня есть некоторые модули python, содержащие в основном функции и несколько классов. Каждый из них документируется с использованием sphinx-autodoc в отдельном первом. Я хочу сделать, чтобы создать таблицу или список содержимого модуля вверху каждой страницы, например, mymodule.py

def first():
    'First function'

def second():
    'Second function'

И mymodule.rst

Page Contents
-------------

:create_page_contents_list:

Members
-------

.. automodule:: mymodule
    :members:

Затем вывод должен выглядеть примерно так:

Page Contents
-------------

first
second

Members
-------

first()
    First function

second()
    Second function

Вопрос, как сделать :create_page_contents_list:. Я взглянул на использование TOC, но мне кажется, что мне нужно будет вручную создать запись для каждого элемента. Я также посмотрел на autosummary, но мне все еще нужно перечислять участников. Любые предложения по автоматизации этого? Я предпочел бы избежать сторонних расширений.

4b9b3361

Ответ 1

Вероятно, вам понадобится что-то вроде автозаполнения. Фактическое автозаполнение не будет делать то, что вы хотите.

Пример того, как вы можете расширить автозаполнение для автоматического определения содержимого модуля, дается в этом ответе