Add dirhtml build test

Author: sitic

tests/extension/__init__.py

@@ -313,14 +313,70 @@ def test_skip_identical_code(tmp_path: Path):
     assert "sphinx-codeautolink-a" in str(blocks[1])
 
 
+def test_dirhtml_builder(tmp_path: Path):
+    index = """
+Test project
+============
+
+.. toctree::
+   :maxdepth: 2
+
+   page1/index
+   page2
+   subdir/page3
+
+Index Page Code
+---------------
+
+.. code:: python
+
+   import test_project
+   test_project.bar()
+
+.. automodule:: test_project
+"""
+
+    page = """
+Page {idx}
+===========
+
+.. code:: python
+
+   import test_project
+   test_project.bar()
+
+.. autolink-examples:: test_project.bar
+"""
+
+    files = {
+        "conf.py": default_conf,
+        "index.rst": index,
+        "page1/index.rst": page.format(idx=1),
+        "page2.rst": page.format(idx=2),
+        "subdir/page3.rst": page.format(idx=3),
+    }
+    links = ["test_project", "test_project.bar"]
+
+    result_dir = _sphinx_build(tmp_path, "dirhtml", files)
+
+    assert_links(result_dir / "index.html", links)
+    assert_links(result_dir / "page1/index.html", links)
+    assert_links(result_dir / "page2/index.html", links)
+    assert_links(result_dir / "subdir/page3/index.html", links)
+
+    assert check_link_targets(result_dir) == len(links) * 4
+
+
 def _sphinx_build(
     folder: Path, builder: str, files: dict[str, str], n_processes: int | None = None
 ) -> Path:
     """Build Sphinx documentation and return result folder."""
     src_dir = folder / "src"
     src_dir.mkdir(exist_ok=True)
     for name, content in files.items():
-        (src_dir / name).write_text(content, "utf-8")
+        path = src_dir / name
+        path.parent.mkdir(exist_ok=True, parents=True)
+        path.write_text(content, "utf-8")
 
     build_dir = folder / "build"
     args = ["-M", builder, str(src_dir), str(build_dir), "-W"]

tests/extension/_check.py

@@ -12,7 +12,7 @@
 def check_link_targets(root: Path) -> int:
     """Validate links in HTML site at root, return number of links found."""
     site_docs = {
-        p.relative_to(root): BeautifulSoup(p.read_text("utf-8"), "html.parser")
+        p: BeautifulSoup(p.read_text("utf-8"), "html.parser")
         for p in root.glob("**/*.html")
     }
     site_ids = {k: gather_ids(v) for k, v in site_docs.items()}
@@ -27,14 +27,18 @@ def check_link_targets(root: Path) -> int:
                     external_site_ids[base] = gather_ids(sub_soup)
                 ids = external_site_ids[base]
             else:
-                if base == "":
-                    base = str(doc)
-                elif base == "../":
-                    base = str(doc.parent.parent / "index.html")
-                ids = site_ids[Path(base)]
+                target_path = (doc.parent / base).resolve()
+                if target_path.is_dir():
+                    target_path /= "index.html"
+                assert target_path.exists(), (
+                    f"Target path {target_path!s} not found while validating"
+                    f" link for `{link.string}` in {doc.relative_to(root)!s}!"
+                )
+                ids = site_ids[target_path]
+
             assert id_ in ids, (
-                f"ID {id_} not found in {base}"
-                f" while validating link for `{link.string}` in {doc!s}!"
+                f"ID {id_} not found in {base} while validating link"
+                f" for `{link.string}` in {doc.relative_to(root)!s}!"
             )
             total += 1
     return total