Fix rendering of admonition in docs #18163
Merged
+3
−0
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
dhruvmanila
reviewed
May 18, 2025
6b535bc to
4e15f3c
Compare
|
Commit has now landed in a release so pin can be removed (in the future, it might be good to add a comment to the requirements.txt providing the reason for a pinned dependency) |
corneliusroemer
added a commit
to corneliusroemer/ruff
that referenced
this pull request
Jul 15, 2025
Renovate doesn't upgrade sha-pinned dependencies. The pin was introduced due to the bug fix not being available in a released version in PR astral-sh#18163 Now the bug fix has been released so the pin can be removed. In the future, in such cases, it might be a good idea to add a comment and/or set a reminder to look back and consider removing the pin as renovate will not handle sha pins. As renovate handles almost all dep upgrades, this provides a false sense of "security" that deps are always kept up to date automatically. Related to issue astral-sh#19369 Thanks @ntBre for the pointer!
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.
Summary
GitHub and mkdocs use different syntaxes for admonition. The mkdocs admonition have more features but we have some markdown files that are both rendered on GitHub and mkdocs.
This PR includes a mkdocs plugin that transforms GitHub admonition to mkdocs admonitions.
An alternative to the extension is to extend
generate_mkdocsto also replace admonitions. Given that the plugin already exists, this seemed easier.I had to tag a specific commit because the pypi release doen't include the fix for PGijsbers/admonitions#3
Fixes #18158
Test Plan
Build the docs locally