Skip to content

Commit ff612de

Browse files
committed
Mention DIRHTML builder in docs
1 parent beafd53 commit ff612de

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

docs/src/about.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ is injected after the ordinary Sphinx build is finished.
1616

1717
Caveats
1818
-------
19-
- **Only works with HTML documentation**, disabled otherwise. If the extension
19+
- **Only works with HTML or DIRHTML documentation**, disabled otherwise. If the extension
2020
is off, it silently removes directives that would produce output.
2121
- **Only processes blocks, not inline code**. Sphinx has great tools
2222
for linking definitions inline, and longer code should be in a block anyway.

docs/src/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Caveats
6868
-------
6969
For a more thorough explanation, see :ref:`about`.
7070

71-
- Only works with HTML documentation
71+
- Only works with HTML or DIRHTML documentation
7272
- Only processes blocks, not inline code
7373
- Doesn't run example code
7474
- Parsing and type hint resolving is incomplete

tests/extension/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ def test_parallel_build(builder: str, tmp_path: Path):
289289
assert_links(result_dir / file / "index.html", links)
290290
else:
291291
assert_links(result_dir / (file + ".html"), links)
292-
292+
293293
assert check_link_targets(result_dir) == n_subfiles * len(links)
294294

295295

tests/extension/_check.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ def check_link_targets(root: Path) -> int:
2727
external_site_ids[base] = gather_ids(sub_soup)
2828
ids = external_site_ids[base]
2929
else:
30-
if base == '':
30+
if base == "":
3131
base = str(doc)
3232
elif base == "../":
33-
base = str(doc.parent.parent / 'index.html')
33+
base = str(doc.parent.parent / "index.html")
3434
ids = site_ids[Path(base)]
3535
assert id_ in ids, (
3636
f"ID {id_} not found in {base}"

0 commit comments

Comments
 (0)