feature: introduce admonitions to warn about dependency issue in docs #1733
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
Signed-off-by: bossenti <bossenti@posteo.de>
Signed-off-by: bossenti <bossenti@posteo.de>
github-actions
bot
added
dependencies
Signed-off-by: bossenti <bossenti@posteo.de>
bossenti
removed
dependencies
github-actions
bot
added
dependencies
tenthe
approved these changes
Jul 7, 2023
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.
Purpose
This PR introduces the usage of admonitions in our Python docs.
Admonitions are small UI elements that are designed to highlight certain statements, e.g.:
Admonitions can also be collapsed:
See some more supported admonitions: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types
In addition, all base dependencies are now pinned to their current major versions.
Remarks
PR introduces (a) breaking change(s):no
PR introduces (a) deprecation(s): no