mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
78 lines
2.5 KiB
Python
78 lines
2.5 KiB
Python
|
import pytest
|
||
|
|
from docutils import nodes
|
||
|
|
|
||
|
|
from sphinx import addnodes
|
||
|
|
from sphinx.testing.util import SphinxTestApp
|
||
|
|
from sphinx.transforms import MoveModuleTargets
|
||
|
|
|
||
|
|
CONTENT_PY = """\
|
||
|
|
move-module-targets
|
||
|
|
===================
|
||
|
|
|
||
|
|
.. py:module:: fish_licence.halibut
|
||
|
|
"""
|
||
|
|
CONTENT_JS = """\
|
||
|
|
move-module-targets
|
||
|
|
===================
|
||
|
|
|
||
|
|
.. js:module:: fish_licence.halibut
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
@pytest.mark.parametrize('content', [
|
||
|
|
CONTENT_PY, # Python
|
||
|
|
CONTENT_JS, # JavaScript
|
||
|
|
])
|
||
|
|
@pytest.mark.usefixtures("rollback_sysmodules")
|
||
|
|
def test_move_module_targets(tmp_path, content):
|
||
|
|
# Test for the MoveModuleTargets transform
|
||
|
|
tmp_path.joinpath("conf.py").touch()
|
||
|
|
tmp_path.joinpath("index.rst").write_text(content, encoding="utf-8")
|
||
|
|
|
||
|
|
app = SphinxTestApp('dummy', srcdir=tmp_path)
|
||
|
|
app.build(force_all=True)
|
||
|
|
document = app.env.get_doctree('index')
|
||
|
|
section = document[0]
|
||
|
|
|
||
|
|
# target ID has been lifted into the section node
|
||
|
|
assert section["ids"] == ['module-fish_licence.halibut', 'move-module-targets']
|
||
|
|
# nodes.target has been removed from 'section'
|
||
|
|
assert isinstance(section[0], nodes.title)
|
||
|
|
assert isinstance(section[1], addnodes.index)
|
||
|
|
assert len(section) == 2
|
||
|
|
|
||
|
|
|
||
|
|
@pytest.mark.usefixtures("rollback_sysmodules")
|
||
|
|
def test_move_module_targets_no_section(tmp_path):
|
||
|
|
# Test for the MoveModuleTargets transform
|
||
|
|
tmp_path.joinpath("conf.py").touch()
|
||
|
|
tmp_path.joinpath("index.rst").write_text(".. py:module:: fish_licence.halibut\n", encoding="utf-8")
|
||
|
|
|
||
|
|
app = SphinxTestApp('dummy', srcdir=tmp_path)
|
||
|
|
app.build(force_all=True)
|
||
|
|
document = app.env.get_doctree('index')
|
||
|
|
|
||
|
|
assert document["ids"] == []
|
||
|
|
|
||
|
|
|
||
|
|
@pytest.mark.usefixtures("rollback_sysmodules")
|
||
|
|
def test_move_module_targets_disabled(tmp_path):
|
||
|
|
# Test for the MoveModuleTargets transform
|
||
|
|
tmp_path.joinpath("conf.py").touch()
|
||
|
|
tmp_path.joinpath("index.rst").write_text(CONTENT_PY, encoding="utf-8")
|
||
|
|
|
||
|
|
app = SphinxTestApp('dummy', srcdir=tmp_path)
|
||
|
|
app.registry.transforms.remove(MoveModuleTargets) # disable the transform
|
||
|
|
app.build(force_all=True)
|
||
|
|
document = app.env.get_doctree('index')
|
||
|
|
section = document[0]
|
||
|
|
|
||
|
|
# target ID is not lifted into the section node
|
||
|
|
assert section["ids"] == ['move-module-targets']
|
||
|
|
assert section[2]["ids"] == ['module-fish_licence.halibut']
|
||
|
|
# nodes.target remains in 'section'
|
||
|
|
assert isinstance(section[0], nodes.title)
|
||
|
|
assert isinstance(section[1], addnodes.index)
|
||
|
|
assert isinstance(section[2], nodes.target)
|
||
|
|
assert len(section) == 3
|