Fix broken @extref links breaking the docs build#598
Merged
Conversation
Two external cross-references no longer resolve against the upstream
inventories, and makedocs treats :external_cross_references as fatal, so
the Documentation job fails before rendering:
- JuliaFormatter registers `format` as a jl:function with no signature
suffix, so `JuliaFormatter.format-Tuple{Any}` is gone.
- PowerSystems renamed the time-series tutorial page, dropping the
`tutorial_time_series` label.
Also convert a hard-coded URL to the same (renamed, now 404ing)
PowerSystems tutorial into an @extref, per the guidance in
general_formatting.md.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #598 +/- ##
==========================================
- Coverage 78.88% 78.86% -0.02%
==========================================
Files 75 75
Lines 6660 6649 -11
==========================================
- Hits 5254 5244 -10
+ Misses 1406 1405 -1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
jd-lara
approved these changes
Jul 26, 2026
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
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.
Problem
The
DocumentationCI job has been failing onmainsince run 27879924041 (2026-06-20), and on every open PR branch as a result. Two@extref(DocumenterInterLinks) references no longer resolve against the upstream inventories, andmakedocstreats:external_cross_referencesas fatal:Because the failure happens in the external-link phase, the build terminates before rendering — nothing else in the CI log is a real signal.
Cause and fix
docs_best_practices/how-to/troubleshoot.md@extref `JuliaFormatter.format-Tuple{Any}`formatas ajl:functionwith no signature suffix@extref JuliaFormatter.formatdocs_best_practices/how-to/write_a_tutorial.md@extref tutorial_time_series@extref PowerSystems :doc:`tutorials/generated_working_with_time_series`Also converts a hard-coded URL to that same PowerSystems tutorial (
write_a_tutorial.md:13) into an@extref. It currently 404s for the same rename reason — Documenter doesn't linkcheck it, so it wasn't a build failure, just a dead link.general_formatting.mdin this same guide tells authors to prefer@extrefover hard-coded URLs.Verification
julia --project=docs docs/make.jlexits 0 with zerocannot resolve external linkerrors. Confirmed the rendered HTML points at live URLs:https://juliaeditorsupport.github.io/JuliaFormatter.jl/stable/api/#JuliaFormatter.formathttps://sienna-platform.github.io/PowerSystems.jl/stable/tutorials/generated_working_with_time_series/Remaining build warnings (unbalanced
$inInfrastructureSystems.md, the page-size warning) are pre-existing and non-fatal.🤖 Generated with Claude Code