linkcheck: take source directory into account for local files #8245
Conversation
This file contains 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
tk0miya
requested changes
Oct 3, 2020
sphinx/builders/linkcheck.py
Outdated
| @@ -256,7 +256,8 @@ def check() -> Tuple[str, str, int]: | |||
| uri, docname, lineno = self.wqueue.get() | |||
| if uri is None: | |||
| break | |||
| status, info, code = check() | |||
| srcdir = path.dirname(self.env.doc2path(docname)) | |||
| status, info, code = check(srcdir) | |||
There was a problem hiding this comment.
It would be better to pass docname instead of srcdir.
tk0miya
approved these changes
Oct 4, 2020
|
Thank you for update. Merged! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In #7985, the
linkcheckbuilder has been extended to also check local links.However, the local file URIs are checked relative to the global source directory.
If a relative path is used in a source file in a sub-directory, the file is not found and a linkcheck error is reported.
This PR uses the actual source directory of the current source file.
Feature or Bugfix
Relates