mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
2c0943784c
Consider the following piece of reST::
.. automodule:: sphinx.ext.autosummary
:members:
.. autosummary::
sphinx.ext.autosummary.Autosummary
This inserts an autosummary after the module docstring, but before
the members of the module. Without the change in this commit, this
would fail because `import_by_name` would attempt to import::
sphinx.ext.autosummary.sphinx.ext.autosummary.Autosumary
because the prefix (from the parent) is `sphinx.ext.autosummary`,
and the name is `sphinx.ext.autosummary.Autosummary`, which is able
to be imported from `sphinx.ext.autosummary`, but is not the way
that anyone would want to refer to it.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
41 lines
1.5 KiB
Python
41 lines
1.5 KiB
Python
"""Test autosummary for import cycles."""
|
|
|
|
import pytest
|
|
from docutils import nodes
|
|
|
|
from sphinx import addnodes
|
|
from sphinx.ext.autosummary import autosummary_table
|
|
from sphinx.testing.util import assert_node
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='ext-autosummary-import_cycle')
|
|
@pytest.mark.usefixtures("rollback_sysmodules")
|
|
def test_autosummary_import_cycle(app, warning):
|
|
app.build()
|
|
|
|
doctree = app.env.get_doctree('index')
|
|
app.env.apply_post_transforms(doctree, 'index')
|
|
|
|
assert len(list(doctree.findall(nodes.reference))) == 1
|
|
|
|
assert_node(doctree,
|
|
(addnodes.index, # [0]
|
|
nodes.target, # [1]
|
|
nodes.paragraph, # [2]
|
|
addnodes.tabular_col_spec, # [3]
|
|
[autosummary_table, nodes.table, nodes.tgroup, (nodes.colspec, # [4][0][0][0]
|
|
nodes.colspec, # [4][0][0][1]
|
|
[nodes.tbody, nodes.row])], # [4][0][0][2][1]
|
|
addnodes.index, # [5]
|
|
addnodes.desc)) # [6]
|
|
assert_node(doctree[4][0][0][2][0],
|
|
([nodes.entry, nodes.paragraph, (nodes.reference, nodes.Text)], nodes.entry))
|
|
assert_node(doctree[4][0][0][2][0][0][0][0], nodes.reference,
|
|
refid='spam.eggs.Ham', reftitle='spam.eggs.Ham')
|
|
|
|
expected = (
|
|
"Summarised items should not include the current module. "
|
|
"Replace 'spam.eggs.Ham' with 'Ham'."
|
|
)
|
|
assert expected in app.warning.getvalue()
|