docs: fix two dead links breaking linkcheck CI#5575
Merged
Conversation
Two notebook links 404 after the docs site reorganised, failing the linkChecker job and the Read the Docs linkcheck pre_build step on every branch: - source/api/simulation.html -> source/api/simulation/simulation.html - installation/gnu-linux-mac.html#optional-jaxsolver -> installation/index.html#optional-jaxsolver Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5575 +/- ##
=======================================
Coverage 98.18% 98.19%
=======================================
Files 339 339
Lines 31637 31637
=======================================
+ Hits 31064 31065 +1
+ Misses 573 572 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
valentinsulzer
previously approved these changes
Jun 6, 2026
The site is live but its LiteSpeed anti-bot WAF returns 415 to CI/datacenter IPs, breaking the link checker even though the link is valid. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
No code changes. Earlier failures (lychee, test-data downloads, RTD sphinx-linkcheck) were all transient github.com 504 Gateway Timeouts on live links, not real breakages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
BradyPlanden
approved these changes
Jun 8, 2026
BradyPlanden
pushed a commit
that referenced
this pull request
Jun 16, 2026
* docs: fix dead links breaking linkcheck CI Two notebook links 404 after the docs site reorganised, failing the linkChecker job and the Read the Docs linkcheck pre_build step on every branch: - source/api/simulation.html -> source/api/simulation/simulation.html - installation/gnu-linux-mac.html#optional-jaxsolver -> installation/index.html#optional-jaxsolver Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix: ignore bpxstandard.com in lychee (WAF false positive) The site is live but its LiteSpeed anti-bot WAF returns 415 to CI/datacenter IPs, breaking the link checker even though the link is valid. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * ci: re-trigger builds (transient GitHub 504s) No code changes. Earlier failures (lychee, test-data downloads, RTD sphinx-linkcheck) were all transient github.com 504 Gateway Timeouts on live links, not real breakages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> (cherry picked from commit cf4ae1e)
This was referenced Jun 16, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The
linkCheckerGitHub Action and the Read the Docs build'slinkcheckpre_buildstep are currently failing onmainand on every open PR because two hard-codeddocs.pybamm.orglinks 404 after the docs site was reorganised:performance/01-simulation-pipeline.ipynbsource/api/simulation.htmlsource/api/simulation/simulation.htmlsolvers/idaklu-jax-interface.ipynbinstallation/gnu-linux-mac.html#optional-jaxsolverinstallation/index.html#optional-jaxsolverThe
SimulationAPI page now lives undersource/api/simulation/, and theoptional-jaxsolveranchor moved from the (now-removed)gnu-linux-macinstall page intoinstallation/index. Both replacement URLs were verified to return 200.This repoints the two links so docs CI goes green repo-wide. One-line change per notebook; no other content touched.
Type of change
🤖 Generated with Claude Code