feat: Backlinks #739
Merged
feat: Backlinks #739
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
pawamoy
added a commit
that referenced
this pull request
Feb 24, 2025
Handlers must add `backlinks` HTML elements to their templates: ```html <backlinks identifier="some-id" handler="handler-name" /> ``` mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler). Issue-723: #723 Issue-mkdocstrings-python-153: mkdocstrings/python#153 PR-739: #739
pawamoy
added a commit
that referenced
this pull request
Feb 24, 2025
Handlers must add `backlinks` HTML elements to their templates: ```html <backlinks identifier="some-id" handler="handler-name" /> ``` mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler). Issue-723: #723 Issue-mkdocstrings-python-153: mkdocstrings/python#153 PR-739: #739
pawamoy
added a commit
that referenced
this pull request
Feb 24, 2025
Handlers must add `backlinks` HTML elements to their templates: ```html <backlinks identifier="some-id" handler="handler-name" /> ``` mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler). Issue-723: #723 Issue-mkdocstrings-python-153: mkdocstrings/python#153 PR-739: #739
pawamoy
added a commit
that referenced
this pull request
Feb 24, 2025
Handlers must add `backlinks` HTML elements to their templates: ```html <backlinks identifier="some-id" handler="handler-name" /> ``` mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler). Issue-723: #723 Issue-mkdocstrings-python-153: mkdocstrings/python#153 PR-739: #739
pawamoy
added a commit
that referenced
this pull request
Mar 8, 2025
Handlers must add `backlinks` HTML elements to their templates: ```html <backlinks identifier="some-id" handler="handler-name" /> ``` mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler). Issue-723: #723 Issue-mkdocstrings-python-153: mkdocstrings/python#153 PR-739: #739
We need version 1.6 for combined events.
… for `on_env` This is required because we must run things in `on_env` *before* autorefs, and the backlinks feature will need to run things *after* autorefs.
This will be useful for the backlinks feature. Additionally, use autorefs `current_page` as a `Page` object, not a string (URL).
pawamoy
added a commit
that referenced
this pull request
Mar 10, 2025
Handlers must add `backlinks` HTML elements to their templates: ```html <backlinks identifier="some-id" handler="handler-name" /> ``` mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler). Issue-723: #723 Issue-mkdocstrings-python-153: mkdocstrings/python#153 PR-739: #739
Handlers must add `backlinks` HTML elements to their templates: ```html <backlinks identifier="some-id" handler="handler-name" /> ``` mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler). Issue-723: #723 Issue-mkdocstrings-python-153: mkdocstrings/python#153 PR-739: #739
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.
Closes #723