Исключить унаследованные методы класса в автосборке sphinxPython

Программы на Python
Ответить Пред. темаСлед. тема
Anonymous
 Исключить унаследованные методы класса в автосборке sphinx

Сообщение Anonymous »

У меня есть пакет Python, и я хочу создать документацию по API с автоматическим расширением sphinx.
Проблема, с которой я столкнулся, заключается в том, что мой основной класс пакета наследует от PyTorch nn. Module, и при запуске autosummary в моем пакете он пытается документировать все методы в nn.Module, чего я не хочу.
Есть ли способ сделать autosummary игнорирует эти унаследованные методы?
Я также использую следующий вызов autosummary:

Код: Выделить всё

.. autosummary::
:toctree: generated/
:recursive:

my_package
Мой проблемный класс находится в модуле my_package.model.MyClass.
Я пробовал играть с autodoc_default_options:

Код: Выделить всё

autodoc_default_options = {
'members': True,
'undoc-members': False,
'private-members': False,
'special-members': False,
'inherited-members': False,
'show-inheritance': True,
'module-first': True,
}
Но это не сработало.

Подробнее здесь: https://stackoverflow.com/questions/791 ... utosummary
Реклама
Ответить Пред. темаСлед. тема

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

  • Похожие темы
    Ответы
    Просмотры
    Последнее сообщение

Вернуться в «Python»