python-将setUp和tearDown unittest方法保留在Sphinx文档之外

我正在使用docstrings和autodoc使用Sphinx为我的项目构建文档.我喜欢在文档中包含测试类和实际测试用例的描述,但是我想省略setUp和tearDown.我尝试在.rst文件中指定它,但是我没有用(不是我真的期望它,我敢肯定,undoc成员仅适用于顶级构造-全局函数和类)

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

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

有谁知道一种设置狮身人面像的方法,以便setUp和tearDown方法甚至不会出现在文档中？

解决方法:

你会需要：

:exclude-members: setUp, tearDown

undoc-members告诉sphinx甚至记录没有docstring的方法.

标签：python-sphinx,python
来源： https://codeday.me/bug/20191121/2054399.html