Skip to content

CI: check for dead links #792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Vierkantor wants to merge 4 commits into
base: lean4
Choose a base branch
from
Open

CI: check for dead links #792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8ff5b55
CI: check for dead links
Vierkantor Feb 19, 2026
261e0d5
Add write permission to PRs.
Vierkantor Feb 21, 2026
6d38b39
Remove duplicate permissions entry in build_pr.yml
bryangingechen Feb 21, 2026
7901a76
fix: rewrite all doc-relative links in header HTML, fix glossary link
kim-em Mar 4, 2026
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
16 changes: 16 additions & 0 deletions .github/workflows/build_pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ concurrency:

permissions:
contents: write
pull-requests: write

jobs:
build:
Expand Down Expand Up @@ -46,3 +47,18 @@ jobs:
with:
name: site
path: build/

- name: Check links
id: check-links
uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0 # v2.7.0
with:
args: --no-progress --offline --root-dir $PWD'/build' --exclude '/mathlib4_docs' --exclude '/queueboard' --exclude '/blog' './build/**/*.html'
fail: false

- name: Add comment to PR about link check outcome
id: check-links-comment
uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4
if: steps.check-links.outputs.exit_code != 0
with:
header: 'Link check errors'
path: ./lychee/out.md
5 changes: 3 additions & 2 deletions make_site.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,8 +408,9 @@ def download_N_theorems(kind: NTheorems) -> dict:
except KeyError:
print(f'Error: {thms} entry {id} refers to a nonexistent declaration {decl}')
continue
# note: the `header-data.json` data file uses doc-relative links
header = decl_info.header.replace('href="./Mathlib/', 'href="./mathlib4_docs/Mathlib/')
# note: the `header-data.json` data file uses doc-relative links;
# rewrite all of them to point into the mathlib4_docs subdirectory
header = decl_info.header.replace('href="./', 'href="./mathlib4_docs/')
doc_decls.append(DocDecl(
name=decl,
decl_header_html = header,
Expand Down
2 changes: 1 addition & 1 deletion templates/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ Good `simp` lemmas guide the `simp` tactic towards reducing complex expressions

A convention within [Mathlib](#Mathlib) for expressing propositions with multiple equivalent forms in a single conventional one.

Examples and further detail can be found on [the `simp` page](simp.html#simp-normal-form).
Examples and further detail can be found on [the `simp` page](extras/simp.html#simp-normal-form).

### syntax linter

Expand Down