refactor: Split out autorefs plugin, make it optional #220
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
"autorefs" is now a self-sufficient MkDocs plugin, just allowing linking to headings on any page.
As for mkdocstrings, unless users opt into using autorefs for any heading (done by scanning the ToC as before), this will now only do autorefs to mkdocstrings identifiers.
Opting in is done by just enabling 'autorefs' as a separate plugin, which it now is.
The new behavior of linking only to identifiers is implemented by force-including the autorefs plugin even if it's not specified, but in a "subdued" mode. Idea inspired by the interaction between pymdownx.{superfences,highlight}.
|
A rebase and some quality fixes (missing docstrings mostly), and we're good to go. |
|
OK, the tornado vulnerability can be fixed later with a dependency upgrade, lets' merge! |
This was referenced Mar 15, 2021
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.
"autorefs" is now a self-sufficient MkDocs plugin, just allowing linking to headings on any page.
As for mkdocstrings, unless users opt into using autorefs for any heading (done by scanning the ToC as before), this will now only do autorefs to mkdocstrings identifiers.
Opting in is done by just enabling 'autorefs' as a separate plugin, which it now is.
The new behavior of linking only to identifiers is implemented by force-including the autorefs plugin even if it's not specified, but in a "subdued" mode. Idea inspired by the interaction between pymdownx.{superfences,highlight}.