Python sphinx как перечислить имена функций модуля - PullRequest
0 голосов
/ 17 октября 2018

Как вывести список имен и сводок функций?

Прямо сейчас у меня есть

.. automodule:: module_dir.module_name
   :members:

, который возвращает всю строку документации каждой функции, что для меня слишком много.Есть ли возможность ограничить вывод или получить только имена функций?

1 Ответ

0 голосов
/ 19 октября 2018

Эту часть кода необходимо добавить в conf.py, чтобы избавиться от всех строк документации.

   def process_docstring(app, what, name, obj, options, lines):
        """
        Deletes unnecessary docstring
        """
        if what != "module":
            del lines[:]

    def setup(app):
        app.connect('autodoc-process-docstring', process_docstring)
...