apidoc: Rename test roots

sphinx-doc · Jan 7, 2025 · 74ec220 · 74ec220
1 parent 8e6883f
commit 74ec220
Show file tree

Hide file tree

Showing 30 changed files with 30 additions and 18 deletions.
diff --git a/...tom-templates/_templates/module.rst.jinja → ...tom-templates/_templates/module.rst.jinja b/...tom-templates/_templates/module.rst.jinja → ...tom-templates/_templates/module.rst.jinja
diff --git a/...-custom-templates/_templates/module.rst_t → ...-custom-templates/_templates/module.rst_t b/...-custom-templates/_templates/module.rst_t → ...-custom-templates/_templates/module.rst_t
diff --git a/...custom-templates/_templates/package.rst_t → ...custom-templates/_templates/package.rst_t b/...custom-templates/_templates/package.rst_t → ...custom-templates/_templates/package.rst_t
diff --git a/...oc-custom-templates/mypackage/__init__.py → ...oc-custom-templates/mypackage/__init__.py b/...oc-custom-templates/mypackage/__init__.py → ...oc-custom-templates/mypackage/__init__.py
diff --git a/...oc-custom-templates/mypackage/mymodule.py → ...oc-custom-templates/mypackage/mymodule.py b/...oc-custom-templates/mypackage/mymodule.py → ...oc-custom-templates/mypackage/mymodule.py
diff --git a/...ce/halibut.cpython-38-x86_64-linux-gnu.so → ...ce/halibut.cpython-38-x86_64-linux-gnu.so b/...ce/halibut.cpython-38-x86_64-linux-gnu.so → ...ce/halibut.cpython-38-x86_64-linux-gnu.so
diff --git a/...pidoc-duplicates/fish_licence/halibut.pyx → ...pidoc-duplicates/fish_licence/halibut.pyx b/...pidoc-duplicates/fish_licence/halibut.pyx → ...pidoc-duplicates/fish_licence/halibut.pyx
diff --git a/...oots/test-apidoc-pep420/a/b/c/__init__.py → .../test-ext-apidoc-pep420/a/b/c/__init__.py b/...oots/test-apidoc-pep420/a/b/c/__init__.py → .../test-ext-apidoc-pep420/a/b/c/__init__.py
diff --git a/tests/roots/test-apidoc-pep420/a/b/c/d.py → ...s/roots/test-ext-apidoc-pep420/a/b/c/d.py b/tests/roots/test-apidoc-pep420/a/b/c/d.py → ...s/roots/test-ext-apidoc-pep420/a/b/c/d.py
diff --git a/...oots/test-apidoc-pep420/a/b/e/__init__.py → .../test-ext-apidoc-pep420/a/b/e/__init__.py b/...oots/test-apidoc-pep420/a/b/e/__init__.py → .../test-ext-apidoc-pep420/a/b/e/__init__.py
diff --git a/tests/roots/test-apidoc-pep420/a/b/e/f.py → ...s/roots/test-ext-apidoc-pep420/a/b/e/f.py b/tests/roots/test-apidoc-pep420/a/b/e/f.py → ...s/roots/test-ext-apidoc-pep420/a/b/e/f.py
diff --git a/tests/roots/test-apidoc-pep420/a/b/x/y.py → ...s/roots/test-ext-apidoc-pep420/a/b/x/y.py b/tests/roots/test-apidoc-pep420/a/b/x/y.py → ...s/roots/test-ext-apidoc-pep420/a/b/x/y.py
diff --git a/...idoc-subpackage-in-toc/parent/__init__.py → ...idoc-subpackage-in-toc/parent/__init__.py b/...idoc-subpackage-in-toc/parent/__init__.py → ...idoc-subpackage-in-toc/parent/__init__.py
diff --git a/...ubpackage-in-toc/parent/child/__init__.py → ...ubpackage-in-toc/parent/child/__init__.py b/...ubpackage-in-toc/parent/child/__init__.py → ...ubpackage-in-toc/parent/child/__init__.py
diff --git a/...doc-subpackage-in-toc/parent/child/foo.py → ...doc-subpackage-in-toc/parent/child/foo.py b/...doc-subpackage-in-toc/parent/child/foo.py → ...doc-subpackage-in-toc/parent/child/foo.py
diff --git a/...ots/test-apidoc-toc/mypackage/__init__.py → ...test-ext-apidoc-toc/mypackage/__init__.py b/...ots/test-apidoc-toc/mypackage/__init__.py → ...test-ext-apidoc-toc/mypackage/__init__.py
diff --git a/...s/roots/test-apidoc-toc/mypackage/main.py → ...ots/test-ext-apidoc-toc/mypackage/main.py b/...s/roots/test-apidoc-toc/mypackage/main.py → ...ots/test-ext-apidoc-toc/mypackage/main.py
diff --git a/.../test-apidoc-toc/mypackage/no_init/foo.py → ...t-ext-apidoc-toc/mypackage/no_init/foo.py b/.../test-apidoc-toc/mypackage/no_init/foo.py → ...t-ext-apidoc-toc/mypackage/no_init/foo.py
diff --git a/...apidoc-toc/mypackage/resource/__init__.py → ...apidoc-toc/mypackage/resource/__init__.py b/...apidoc-toc/mypackage/resource/__init__.py → ...apidoc-toc/mypackage/resource/__init__.py
diff --git a/...pidoc-toc/mypackage/resource/resource.txt → ...pidoc-toc/mypackage/resource/resource.txt b/...pidoc-toc/mypackage/resource/resource.txt → ...pidoc-toc/mypackage/resource/resource.txt
diff --git a/...pidoc-toc/mypackage/something/__init__.py → ...pidoc-toc/mypackage/something/__init__.py b/...pidoc-toc/mypackage/something/__init__.py → ...pidoc-toc/mypackage/something/__init__.py
diff --git a/...-trailing-underscore/package_/__init__.py → ...-trailing-underscore/package_/__init__.py b/...-trailing-underscore/package_/__init__.py → ...-trailing-underscore/package_/__init__.py
diff --git a/...c-trailing-underscore/package_/module_.py → ...c-trailing-underscore/package_/module_.py b/...c-trailing-underscore/package_/module_.py → ...c-trailing-underscore/package_/module_.py
diff --git a/tests/roots/test-autosummary/conf.py → tests/roots/test-ext-autosummary-ext/conf.py b/tests/roots/test-autosummary/conf.py → tests/roots/test-ext-autosummary-ext/conf.py
diff --git a/tests/roots/test-autosummary/dummy_module.py → .../test-ext-autosummary-ext/dummy_module.py b/tests/roots/test-autosummary/dummy_module.py → .../test-ext-autosummary-ext/dummy_module.py
diff --git a/tests/roots/test-autosummary/index.rst → .../roots/test-ext-autosummary-ext/index.rst b/tests/roots/test-autosummary/index.rst → .../roots/test-ext-autosummary-ext/index.rst
diff --git a/tests/roots/test-autosummary/sphinx.rst → ...roots/test-ext-autosummary-ext/sphinx.rst b/tests/roots/test-autosummary/sphinx.rst → ...roots/test-ext-autosummary-ext/sphinx.rst
diff --git a/...ts/test-autosummary/underscore_module_.py → ...ext-autosummary-ext/underscore_module_.py b/...ts/test-autosummary/underscore_module_.py → ...ext-autosummary-ext/underscore_module_.py
diff --git a/tests/test_extensions/test_ext_apidoc.py b/tests/test_extensions/test_ext_apidoc.py
@@ -60,10 +60,10 @@ def test_simple(make_app, apidoc):
 
 
 @pytest.mark.apidoc(
-    coderoot='test-apidoc-custom-templates',
+    coderoot='test-ext-apidoc-custom-templates',
     options=[
         '--separate',
-        '--templatedir=tests/roots/test-apidoc-custom-templates/_templates',
+        '--templatedir=tests/roots/test-ext-apidoc-custom-templates/_templates',
     ],
 )
 def test_custom_templates(make_app, apidoc):
@@ -95,7 +95,7 @@ def test_custom_templates(make_app, apidoc):
 
 
 @pytest.mark.apidoc(
-    coderoot='test-apidoc-pep420/a',
+    coderoot='test-ext-apidoc-pep420/a',
     options=['--implicit-namespaces'],
 )
 def test_pep_0420_enabled(make_app, apidoc):
@@ -143,7 +143,7 @@ def test_pep_0420_enabled(make_app, apidoc):
 
 
 @pytest.mark.apidoc(
-    coderoot='test-apidoc-pep420/a',
+    coderoot='test-ext-apidoc-pep420/a',
     options=['--implicit-namespaces', '--separate'],
 )
 def test_pep_0420_enabled_separate(make_app, apidoc):
@@ -192,7 +192,7 @@ def test_pep_0420_enabled_separate(make_app, apidoc):
     assert 'a.b.x namespace\n' in txt
 
 
-@pytest.mark.apidoc(coderoot='test-apidoc-pep420/a')
+@pytest.mark.apidoc(coderoot='test-ext-apidoc-pep420/a')
 def test_pep_0420_disabled(make_app, apidoc):
     outdir = apidoc.outdir
     assert (outdir / 'conf.py').is_file()
@@ -205,7 +205,7 @@ def test_pep_0420_disabled(make_app, apidoc):
     print(app._warning.getvalue())
 
 
-@pytest.mark.apidoc(coderoot='test-apidoc-pep420/a/b')
+@pytest.mark.apidoc(coderoot='test-ext-apidoc-pep420/a/b')
 def test_pep_0420_disabled_top_level_verify(make_app, apidoc):
     outdir = apidoc.outdir
     assert (outdir / 'conf.py').is_file()
@@ -224,7 +224,7 @@ def test_pep_0420_disabled_top_level_verify(make_app, apidoc):
     print(app._warning.getvalue())
 
 
-@pytest.mark.apidoc(coderoot='test-apidoc-trailing-underscore')
+@pytest.mark.apidoc(coderoot='test-ext-apidoc-trailing-underscore')
 def test_trailing_underscore(make_app, apidoc):
     outdir = apidoc.outdir
     assert (outdir / 'conf.py').is_file()
@@ -243,7 +243,7 @@ def test_trailing_underscore(make_app, apidoc):
 
 
 @pytest.mark.apidoc(
-    coderoot='test-apidoc-pep420/a',
+    coderoot='test-ext-apidoc-pep420/a',
     excludes=['b/c/d.py', 'b/e/f.py', 'b/e/__init__.py'],
     options=['--implicit-namespaces', '--separate'],
 )
@@ -261,7 +261,7 @@ def test_excludes(apidoc):
 
 
 @pytest.mark.apidoc(
-    coderoot='test-apidoc-pep420/a',
+    coderoot='test-ext-apidoc-pep420/a',
     excludes=['b/e'],
     options=['--implicit-namespaces', '--separate'],
 )
@@ -278,7 +278,7 @@ def test_excludes_subpackage_should_be_skipped(apidoc):
 
 
 @pytest.mark.apidoc(
-    coderoot='test-apidoc-pep420/a',
+    coderoot='test-ext-apidoc-pep420/a',
     excludes=['b/e/f.py'],
     options=['--implicit-namespaces', '--separate'],
 )
@@ -295,7 +295,7 @@ def test_excludes_module_should_be_skipped(apidoc):
 
 
 @pytest.mark.apidoc(
-    coderoot='test-apidoc-pep420/a',
+    coderoot='test-ext-apidoc-pep420/a',
     excludes=[],
     options=['--implicit-namespaces', '--separate'],
 )
@@ -353,7 +353,7 @@ def test_extension_parsed(apidoc):
 
 
 @pytest.mark.apidoc(
-    coderoot='test-apidoc-toc/mypackage',
+    coderoot='test-ext-apidoc-toc/mypackage',
     options=['--implicit-namespaces'],
 )
 def test_toc_all_references_should_exist_pep420_enabled(apidoc):
@@ -385,7 +385,7 @@ def test_toc_all_references_should_exist_pep420_enabled(apidoc):
 
 
 @pytest.mark.apidoc(
-    coderoot='test-apidoc-toc/mypackage',
+    coderoot='test-ext-apidoc-toc/mypackage',
 )
 def test_toc_all_references_should_exist_pep420_disabled(apidoc):
     """All references in toc should exist. This test doesn't say if
@@ -432,7 +432,7 @@ def extract_toc(path):
 
 
 @pytest.mark.apidoc(
-    coderoot='test-apidoc-subpackage-in-toc',
+    coderoot='test-ext-apidoc-subpackage-in-toc',
     options=['--separate'],
 )
 def test_subpackage_in_toc(apidoc):
@@ -733,7 +733,7 @@ def test_no_duplicates(rootdir, tmp_path):
         # Ensure test works on Windows
         sphinx.ext.apidoc._generate.PY_SUFFIXES += ('.so',)
 
-        package = rootdir / 'test-apidoc-duplicates' / 'fish_licence'
+        package = rootdir / 'test-ext-apidoc-duplicates' / 'fish_licence'
         outdir = tmp_path / 'out'
         apidoc_main(['-o', str(outdir), '-T', str(package), '--implicit-namespaces'])
 

diff --git a/tests/test_extensions/test_ext_autosummary.py b/tests/test_extensions/test_ext_autosummary.py
@@ -147,7 +147,11 @@ def test_extract_summary(capsys):
     assert err == ''
 
 
-@pytest.mark.sphinx('dummy', testroot='autosummary', confoverrides=defaults.copy())
+@pytest.mark.sphinx(
+    'dummy',
+    testroot='ext-autosummary-ext',
+    confoverrides=defaults.copy(),
+)
 def test_get_items_summary(make_app, app_params):
     import sphinx.ext.autosummary
     import sphinx.ext.autosummary.generate
@@ -219,7 +223,11 @@ def str_content(elem: Element) -> str:
         return ''.join(str_content(e) for e in elem)
 
 
-@pytest.mark.sphinx('xml', testroot='autosummary', confoverrides=defaults.copy())
+@pytest.mark.sphinx(
+    'xml',
+    testroot='ext-autosummary-ext',
+    confoverrides=defaults.copy(),
+)
 def test_escaping(app):
     app.build(force_all=True)
 
@@ -744,7 +752,11 @@ def test_autosummary_filename_map(app):
     assert html_warnings == ''
 
 
-@pytest.mark.sphinx('latex', testroot='autosummary', confoverrides=defaults.copy())
+@pytest.mark.sphinx(
+    'latex',
+    testroot='ext-autosummary-ext',
+    confoverrides=defaults.copy(),
+)
 def test_autosummary_latex_table_colspec(app):
     app.build(force_all=True)
     result = (app.outdir / 'projectnamenotset.tex').read_text(encoding='utf8')