Open
Conversation
|
📦 Docs artifacts are ready: https://github.com/elixir-lang/ex_doc/actions/runs/23216300678/artifacts/5973917985 |
2b4364e to
41bbea2
Compare
ac71531 to
6bfb370
Compare
6bfb370 to
25c7159
Compare
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.
Verify paths in links to
:extraspages when the link includes a directory component.Doesn't affect bare filename links such as
test.md.Before
Before this change, ExDoc effectively matched extra links by
Path.basename(path), so a link like[Guide](guides/bad_dir/guide.md)could still resolve if there was any extra namedguide.mdin the flattened output namespace.After
After this change, ExDoc keeps bare filename links as the legacy flattened lookup, but treats links with a directory component as path-qualified and resolves them through the extra source tree instead.
Design Decision
The main design question in this PR is how to interpret links to extras depending on the shape of the markdown path.
[Intro](intro.md)[Intro](guides/intro.md)[Intro](../guides/intro.md)[Intro](/guides/intro.md)More concretely, if the current extra source file is
guides/current.md:intro.mdintro.md./intro.mdguides/intro.mdguides/intro.mdguides/guides/intro.md../guides/intro.mdguides/intro.md/guides/intro.mdguides/intro.mdfrom project rootSo
guides/intro.mdis not project-root-relative. Only/guides/intro.mdis.This keeps the legacy behavior for bare filename links while making path-qualified links fail loudly when the specified path is wrong.