Оставьте методы setUp и tearDown unittest в документации Sphinx

Я использую docstrings и autodoc для создания документации для моего проекта с использованием Sphinx. Мне нравится иметь описания классов тестирования и реальных тестовых случаев в моей документации, но я хотел бы оставить установку и демонтаж. Я попытался уточнить это в своем .первый файл, но у меня это не сработало (не то, чтобы я действительно ожидал этого, я довольно уверен, что undoc-члены применимы только к конструкциям верхнего уровня-глобальным функциям и классам) 

API.tests.test_MSSQLTools module
--------------------------------

.. automodule:: API.tests.test_MSSQLTools
    :members:
    :undoc-members: setUp, tearDown
    :show-inheritance:

Кто-нибудь знает способ настроить сфинкс, чтобы методы настройки и демонтажа даже не появлялись в документах?

1 3
python python-sphinx

1 ответ:

Вам понадобится: 

:exclude-members: setUp, tearDown

undoc-members говорит Сфинксу документировать даже методы Без привязок к документам.

3