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

refactor autosummary recursion tests

Browse Source
This commit is contained in:
woutdenolf 2019-07-08 09:06:52 +02:00
parent 4e3046b01a
commit 11d9a97a34
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
tests/test_ext_autosummary.py
View File

@ -260,6 +260,7 @@ def test_autosummary_generate_overwrite2(app_params, make_app):
confoverrides={'autosummary_recursive': True}) confoverrides={'autosummary_recursive': True})
def test_autosummary_recursive_enabled(app, status, warning): def test_autosummary_recursive_enabled(app, status, warning):
app.build() app.build()
toctree = 'modules' # see module.rst template
# Top-level package # Top-level package
generated = app.srcdir / 'generated' generated = app.srcdir / 'generated'
@ -269,7 +270,7 @@ def test_autosummary_recursive_enabled(app, status, warning):
assert 'package.package' in content assert 'package.package' in content
# Recursively generate modules of top-level package # Recursively generate modules of top-level package
generated /= 'modules' generated /= toctree
assert (generated / 'package.module.rst').exists() assert (generated / 'package.module.rst').exists()
assert (generated / 'package.package.rst').exists() assert (generated / 'package.package.rst').exists()
content = (generated / 'package.package.rst').text() content = (generated / 'package.package.rst').text()
@ -277,18 +278,19 @@ def test_autosummary_recursive_enabled(app, status, warning):
assert 'package.package.package' in content assert 'package.package.package' in content
# Recursively generate modules of sub-package # Recursively generate modules of sub-package
generated /= 'modules' generated /= toctree
assert (generated / 'package.package.module.rst').exists() assert (generated / 'package.package.module.rst').exists()
assert (generated / 'package.package.package.rst').exists() assert (generated / 'package.package.package.rst').exists()
content = (generated / 'package.package.package.rst').text() content = (generated / 'package.package.package.rst').text()
assert 'package.package.package.module' in content assert 'package.package.package.module' in content
assert 'package.package.package.package' not in content assert 'package.package.package.package' not in content
# Last sub-package has no modules # Last sub-package has no sub-packages
generated /= 'modules' generated /= toctree
assert (generated / 'package.package.package.module.rst').exists() assert (generated / 'package.package.package.module.rst').exists()
assert not (generated / 'package.package.package.package.rst').exists() assert not (generated / 'package.package.package.package.rst').exists()
assert not (generated / 'modules').exists() if toctree:
assert not (generated / toctree).exists()
@pytest.mark.sphinx('dummy', testroot='ext-autosummary-recursive', @pytest.mark.sphinx('dummy', testroot='ext-autosummary-recursive',
@ -296,6 +298,7 @@ def test_autosummary_recursive_enabled(app, status, warning):
confoverrides={'autosummary_recursive': False}) confoverrides={'autosummary_recursive': False})
def test_autosummary_recursive_disabled(app, status, warning): def test_autosummary_recursive_disabled(app, status, warning):
app.build() app.build()
toctree = 'modules' # see module.rst template
# Modules should not be generated # Modules should not be generated
generated = app.srcdir / 'generated' generated = app.srcdir / 'generated'
@ -303,7 +306,11 @@ def test_autosummary_recursive_disabled(app, status, warning):
content = (generated / 'package.rst').text() content = (generated / 'package.rst').text()
assert 'package.module' not in content assert 'package.module' not in content
assert 'package.package' not in content assert 'package.package' not in content
assert not (generated / 'modules').exists()
# Recursively generate modules of top-level package (should be missing)
generated /= toctree
assert not (generated / 'package.module.rst').exists()
assert not (generated / 'package.package.rst').exists()
@pytest.mark.sphinx('latex', **default_kw) @pytest.mark.sphinx('latex', **default_kw)