Как остановить префикс имени метода автоматического метода Sphinx с именем класса

Когда я использую автоматический метод Sphinx для документирования определенного метода, например:

.. automethod:: my_module.MyClass.my_method

Полученные документы добавляют имя класса к имени метода следующим образом:

MyClass.my_method(kwarg1=None, kwarg2=None)

    This is the docstring for my_method...

Есть ли способ указать automethod не префикс имени метода с именем класса, чтобы результирующие документы выглядели следующим образом:

my_method(kwarg1=None, kwarg2=None)

    This is the docstring for my_method...

?


python-sphinx autodoc
person amorphic    schedule 30.09.2015    source источник

Ответы (2)


arrow_upward
5
arrow_downward

В дополнение к

add_module_names = False

использовать

.. autofunction:: my_module.MyClass.my_method

вместо automodule и имя класса опущено в сгенерированном документе.

person PhilippReist    schedule 26.02.2019

arrow_upward
6
arrow_downward

Добавьте эту строку в свой файл conf.py

add_module_names = False

person yuanzhen dai    schedule 04.09.2017