IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

[test] add py:currentmodule unit test (#11920)

Browse Source
This commit is contained in:
Frank Dana 2024-02-03 10:14:26 -05:00 committed by GitHub
parent cd2bf0a7e5
commit 41ab0f9a41
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 95 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
tests/test_domains/test_domain_py_pyobject.py
View File

@ -390,3 +390,98 @@ def test_pydecoratormethod_signature(app):
assert 'deco' in domain.objects
assert domain.objects['deco'] == ('index', 'deco', 'method', False)
def test_pycurrentmodule(app):
text = (".. py:module:: Other\n"
"\n"
".. py:module:: Module\n"
".. py:class:: A\n"
"\n"
" .. py:method:: m1\n"
" .. py:method:: m2\n"
"\n"
".. py:currentmodule:: Other\n"
"\n"
".. py:class:: B\n"
"\n"
" .. py:method:: m3\n"
" .. py:method:: m4\n")
domain = app.env.get_domain('py')
doctree = restructuredtext.parse(app, text)
print(doctree)
assert_node(
doctree, (
addnodes.index,
addnodes.index,
addnodes.index,
nodes.target,
nodes.target,
[desc, (
[desc_signature, (
[desc_annotation, ("class", desc_sig_space)],
[desc_addname, "Module."],
[desc_name, "A"],
)],
[desc_content, (
addnodes.index,
[desc, (
[desc_signature, (
[desc_name, "m1"],
[desc_parameterlist, ()],
)],
[desc_content, ()],
)],
addnodes.index,
[desc, (
[desc_signature, (
[desc_name, "m2"],
[desc_parameterlist, ()],
)],
[desc_content, ()],
)],
)],
)],
addnodes.index,
[desc, (
[desc_signature, (
[desc_annotation, ("class", desc_sig_space)],
[desc_addname, "Other."],
[desc_name, "B"],
)],
[desc_content, (
addnodes.index,
[desc, (
[desc_signature, (
[desc_name, "m3"],
[desc_parameterlist, ()],
)],
[desc_content, ()],
)],
addnodes.index,
[desc, (
[desc_signature, (
[desc_name, "m4"],
[desc_parameterlist, ()],
)],
[desc_content, ()],
)],
)],
)],
))
assert 'Module' in domain.objects
assert domain.objects['Module'] == ('index', 'module-Module', 'module', False)
assert 'Other' in domain.objects
assert domain.objects['Other'] == ('index', 'module-Other', 'module', False)
assert 'Module.A' in domain.objects
assert domain.objects['Module.A'] == ('index', 'Module.A', 'class', False)
assert 'Other.B' in domain.objects
assert domain.objects['Other.B'] == ('index', 'Other.B', 'class', False)
assert 'Module.A.m1' in domain.objects
assert domain.objects['Module.A.m1'] == ('index', 'Module.A.m1', 'method', False)
assert 'Module.A.m2' in domain.objects
assert domain.objects['Module.A.m2'] == ('index', 'Module.A.m2', 'method', False)
assert 'Other.B.m3' in domain.objects
assert domain.objects['Other.B.m3'] == ('index', 'Other.B.m3', 'method', False)
assert 'Other.B.m4' in domain.objects
assert domain.objects['Other.B.m4'] == ('index', 'Other.B.m4', 'method', False)