diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-11-05 02:21:47 +0900 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-11-05 02:21:47 +0900 |
commit | 8bf84167a30aa05886fcc1ed8895c8c20e939d89 (patch) | |
tree | 51252d17e9c5a344395d64fe4225759cb04f1f4c /tests/test_ext_autodoc_autoclass.py | |
parent | b93aa3137af650ea01f3a68bb14e822bffe81309 (diff) | |
parent | ab707be1e1def8c904b5df0c5ddeaf2edacca0f6 (diff) | |
download | sphinx-git-8bf84167a30aa05886fcc1ed8895c8c20e939d89.tar.gz |
Merge branch '3.x'
Diffstat (limited to 'tests/test_ext_autodoc_autoclass.py')
-rw-r--r-- | tests/test_ext_autodoc_autoclass.py | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/tests/test_ext_autodoc_autoclass.py b/tests/test_ext_autodoc_autoclass.py new file mode 100644 index 000000000..89a79c2c7 --- /dev/null +++ b/tests/test_ext_autodoc_autoclass.py @@ -0,0 +1,50 @@ +""" + test_ext_autodoc_autoclass + ~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Test the autodoc extension. This tests mainly the Documenters; the auto + directives are tested in a test source file translated by test_build. + + :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +""" + +import pytest + +from test_ext_autodoc import do_autodoc + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_classes(app): + actual = do_autodoc(app, 'function', 'target.classes.Foo') + assert list(actual) == [ + '', + '.. py:function:: Foo()', + ' :module: target.classes', + '', + ] + + actual = do_autodoc(app, 'function', 'target.classes.Bar') + assert list(actual) == [ + '', + '.. py:function:: Bar(x, y)', + ' :module: target.classes', + '', + ] + + actual = do_autodoc(app, 'function', 'target.classes.Baz') + assert list(actual) == [ + '', + '.. py:function:: Baz(x, y)', + ' :module: target.classes', + '', + ] + + actual = do_autodoc(app, 'function', 'target.classes.Qux') + assert list(actual) == [ + '', + '.. py:function:: Qux(foo, bar)', + ' :module: target.classes', + '', + ] + |