Сфинкс: список функций в модуле - PullRequest
11 голосов
/ 19 марта 2012

У меня есть несколько модулей 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:.Я рассмотрел использование оглавления, но мне кажется, что мне нужно было бы вручную создать запись для каждого элемента.Я также посмотрел на autosummary, но мне все еще нужно перечислить участников.Любые предложения по автоматизации этого?Я бы предпочел избегать сторонних расширений.

1 Ответ

2 голосов
/ 21 марта 2012

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

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

...