Restore linkcheck for specs #1950
Open
+92
−4
Conversation
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
Signed-off-by: Filipe Laíns <[email protected]>
for more information, see https://pre-commit.ci
Member
|
Wow, that's a nice idea. Might be useful as an external project too. Though, it looks like the linkcheck job is failing due to this? |
Member
Author
|
Looks like it's failing because linkcheck cannot resolve relative links to |
Signed-off-by: Filipe Laíns <[email protected]>
Member
Author
|
CI is passing now 😊 |
| >>> resolve_local_html_link('https://packaging.python.org/en/latest/specifications/schemas/') | ||
| '{srcdir}/specifications/schemas/index.rst' | ||
| >>> resolve_local_html_link('https://packaging.python.org/en/latest/specifications/schemas/build-details-v1.0.schema.json') | ||
| '{html_extra_path0}/specifications/schemas/build-details-v1.0.schema.json' |
Contributor
There was a problem hiding this comment.
typo?
Suggested change
| '{html_extra_path0}/specifications/schemas/build-details-v1.0.schema.json' | |
| '{html_extra_path}/specifications/schemas/build-details-v1.0.schema.json' |
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.
This PR restores the
linkcheckfunctionality forhttps://packaging.python.org/en/latest/...links.It does so by adding a Sphinx plugin that hooks into the
linkcheck-process-urievent and replaces the original URLs with the corresponding local path.We've had a couple issues with schema links, which need to be specified via the full remote URL (eg. #1889 (comment)). We currently need to ignore them in
linkcheckas it fails to take into account local changes. With this PR, the ability to catch these issues during lint is restored.📚 Documentation preview 📚: https://python-packaging-user-guide--1950.org.readthedocs.build/en/1950/