Включение строки документации в документацию Sphinx

Я хотел бы включить в мою документацию Sphinx только строку документации конкретной функции. Однако, похоже, нет вариантов просто отображать эти детали без связанных определений классов и функций с использованием http://sphinx.pocoo.org/ext/autodoc.html

Я попытался создать класс, как описано в показывать * only * docstring в документации Sphinx , но я не уверен, как это согласуется с шаблоном.

Я также безуспешно пробовал обработчик событий autodoc-process-docstring.

Таким образом, вместо отображения моей документации (как сейчас):

class module.MyClass(param)

    This is the class doc string

    my_method()

        This is my method doc string

Я просто хочу отобразить:

This is my method doc string

Мой текущий шаблон в файле .txt:

.. autoclass:: module.MyClass
    :members: my_method

9
задан Community 23 May 2017 в 12:24
поделиться