Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/scripts/archive_checks.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
from urllib.parse import unquote

INLINE_LINK = re.compile(r"!?\[[^\]]*\]\(([^)]+)\)")
REFERENCE_LINK = re.compile(r"^\[[^\]]+\]:\s*(\S+)")
REFERENCE_LINK = re.compile(r"^\[[^\]]+\]:\s*(\S+)", re.MULTILINE)
EXTERNAL_TARGET = re.compile(r"^[a-zA-Z][a-zA-Z0-9+.-]*:")
CHECKPOINT = re.compile(r"(^|/)\.ipynb_checkpoints/")

Expand Down
25 changes: 25 additions & 0 deletions .github/scripts/tests/test_gate.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,31 @@ def test_escaping_target_is_reported(self) -> None:
finally:
outside.unlink()

def test_reference_definition_below_first_line_is_checked(self) -> None:
page = self.write(
"docs/page.md",
"# Guide\n"
"\n"
"See [the appendix][appendix].\n"
"\n"
"[appendix]: missing.md\n",
)
errors = archive_checks.check_links([page], self.root)
self.assertEqual(len(errors), 1)
self.assertIn("docs/page.md: missing link target: missing.md", errors[0])

def test_resolving_reference_definition_passes(self) -> None:
self.write("docs/appendix.md", "# appendix\n")
page = self.write(
"docs/page.md",
"# Guide\n"
"\n"
"See [the appendix][appendix].\n"
"\n"
"[appendix]: appendix.md\n",
)
self.assertEqual(archive_checks.check_links([page], self.root), [])

def test_non_markdown_files_are_skipped(self) -> None:
script = self.write("docs/note.txt", "[gone](does-not-exist.md)\n")
self.assertEqual(archive_checks.check_links([script], self.root), [])
Expand Down
Loading