将setUp和tearDown unittest方法保留在Sphinx文档中

Question

我正在使用docstrings和autodoc使用Sphinx为我的项目构建文档。我喜欢在我的文档中描述测试类和实际测试用例，但我想省略setUp和tearDown。我尝试在.rst文件中指定它，但是我没有工作（不是我真的期望它，我相当确定undoc成员只适用于顶级构造 - 全局函数和类）

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

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

有没有人知道设置sphinx的方法，以便setUp和tearDown方法甚至不会显示在文档中？

Answer 1

您将需要：

:exclude-members: setUp, tearDown

undoc-members告诉sphinx记录没有docstrings的方法。