Skip to content

[skip changelog] Use correct configuration for MkDocs pymdownx.magiclink extension #823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 23, 2020
Merged

[skip changelog] Use correct configuration for MkDocs pymdownx.magiclink extension #823

merged 1 commit into from
Jul 23, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 12, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Bug fix.

  • What is the current behavior?

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 the squidfunk/mkdocs-material repository, which would result in any references that didn't specify a repository to be relative to that repository, rather than arduino/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:

The feature was added in e7638c7390fda8bb852688b21014ea392727ea67

would result in a link to https://github.com/squidfunk/mkdocs-material/commit/e7638c7390fda8bb852688b21014ea392727ea67 rather than the intended e7638c7.

  • What is the new behavior?

The pymdownx.magiclink extension is correctly configured for use in this repository.

  • Does this PR introduce a breaking change?

No.

@per1234 per1234 added kind/bug topic: documentation Related to documentation for the project labels Jul 12, 2020
The pymdownx.magiclink Python-Markdown extension adds support for GitHub-style auto-linked issue/PR/commit/user references. 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 the squidfunk/mkdocs-material repository, which would result in any references that didn't specify a repository to be relative to that repository, rather than arduino/arduino-cli.
@rsora rsora merged commit 7ed171c into arduino:master Jul 23, 2020
@per1234 per1234 deleted the fix-magiclink-config branch July 23, 2020 12:45
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants