diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2019-11-30 17:21:21 +0900 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2019-12-01 12:51:28 +0900 |
commit | 7c79a6b8d148264daadf98ae06d040c2463d4448 (patch) | |
tree | 3ca032beef57fcd58cd0a39f6195b9d127ff9ffb /tests/test_autodoc.py | |
parent | 9d39b187c1ded8a167c2d6b236a20448477260a9 (diff) | |
download | sphinx-git-7c79a6b8d148264daadf98ae06d040c2463d4448.tar.gz |
Close #5923: autodoc: allow not to document inherited members of specific super class
Diffstat (limited to 'tests/test_autodoc.py')
-rw-r--r-- | tests/test_autodoc.py | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index 5cad89cdf..13ccf80c6 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -582,6 +582,30 @@ def test_autodoc_inherited_members(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_inherited_members_Base(app): + options = {"members": None, + "inherited-members": "Base", + "special-members": None} + + # check methods for object class are shown + actual = do_autodoc(app, 'class', 'target.inheritance.Derived', options) + assert ' .. py:method:: Derived.inheritedmeth()' in actual + assert ' .. py:method:: Derived.inheritedclassmeth' not in actual + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_inherited_members_None(app): + options = {"members": None, + "inherited-members": "None", + "special-members": None} + + # check methods for object class are shown + actual = do_autodoc(app, 'class', 'target.inheritance.Derived', options) + assert ' .. py:method:: Derived.__init__' in actual + assert ' .. py:method:: Derived.__str__' in actual + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') def test_autodoc_imported_members(app): options = {"members": None, "imported-members": None, |