[skip changelog] Use correct configuration for MkDocs pymdownx.magiclink extension #823
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.
Please check if the PR fulfills these requirements
Bug fix.
The
pymdownx.magiclink
Python-Markdown extension adds support for GitHub-style auto-linked issue/PR/commit/user references in the documentation. In order for the issue/PR/commit references to work correctly in the case where no repository is specified, the extension must be configured with the owner and repository name of the repository that is using it. As a result of not having been updated after it was copied, the extension was previously configured for thesquidfunk/mkdocs-material
repository, which would result in any references that didn't specify a repository to be relative to that repository, rather thanarduino/arduino-cli
.For example, with the previous configuration, this Markdown:
See issue #42 for details.
would result in a link to
https://github.com/squidfunk/mkdocs-material/issues/42
rather than the intended #42.similarly, this Markdown:
would result in a link to
https://github.com/squidfunk/mkdocs-material/commit/e7638c7390fda8bb852688b21014ea392727ea67
rather than the intended e7638c7.The
pymdownx.magiclink
extension is correctly configured for use in this repository.No.