docs: use resolvable root-absolute links for internal pages#831
Merged
Conversation
Internal doc links were written as bare root-relative paths (e.g. `guides/pytest`, `guides/packaging-simple`). MyST could not resolve many of these as cross-references: paths are resolved relative to the source file, and the multi-word ones used hyphens where the source files use underscores (`packaging_simple.md`). Unresolved links fell back to raw `BASE_URL` concatenation, which only produced valid URLs when `BASE_URL` ended in a slash. Rewrite them as root-absolute paths with the `.md` extension (`/guides/packaging_simple.md`) so MyST resolves them as real cross-references and emits correct URLs regardless of the `BASE_URL` trailing slash. Assisted-by: ClaudeCode:claude-opus-4.8 Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
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
1 participant
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.
🤖 AI text below 🤖
Internal doc links were written as bare root-relative paths (e.g.
guides/pytest,guides/packaging-simple). MyST couldn't resolve many of these as cross-references — paths resolve relative to the source file, and the multi-word ones used hyphens where the source files use underscores (packaging_simple.md). Unresolved links fell back to rawBASE_URLconcatenation, which only produced valid URLs whenBASE_URLended in a trailing slash.This rewrites them as root-absolute paths with the
.mdextension (/guides/packaging_simple.md) so MyST resolves them as real cross-references and emits correct URLs regardless of theBASE_URLtrailing slash.Verified by building the docs with
BASE_URL=/development(no trailing slash): all internal links now resolve to/development/..., with zero broken concatenated links across all pages.Context: this surfaced downstream in learn.scientific-python.org, which dropped the trailing slash from
BASE_URLto fix a theme JS issue, exposing these latent broken links.📚 Documentation preview 📚: https://scientific-python-cookie--831.org.readthedocs.build/