forked from sphinx-doc/sphinx
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix sphinx-doc#8219: autodoc: Parameters for generic base class are n…
…ot shown
- Loading branch information
Showing
5 changed files
with
95 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
""" | ||
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 sys | ||
|
||
import pytest | ||
|
||
from test_ext_autodoc import do_autodoc | ||
|
||
|
||
@pytest.mark.skipif(sys.version_info < (3, 7), reason='python 3.7+ is required.') | ||
@pytest.mark.sphinx('html', testroot='ext-autodoc') | ||
def test_show_inheritance_for_subclass_of_generic_type(app): | ||
options = {'show-inheritance': True} | ||
actual = do_autodoc(app, 'class', 'target.classes.Qux', options) | ||
assert list(actual) == [ | ||
'', | ||
'.. py:class:: Qux(iterable=(), /)', | ||
' :module: target.classes', | ||
'', | ||
' Bases: :class:`List`\\ [:obj:`Union`\\ [:class:`int`, :class:`float`]]', | ||
'', | ||
' A subclass of List[Union[int, float]]', | ||
'', | ||
] | ||
|