-
Notifications
You must be signed in to change notification settings - Fork 17
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
mkdocs: Fix numbered code annotations #684
Merged
llucax
merged 2 commits into
frequenz-floss:v0.x.x
from
llucax:fix-numbered-annotations
Sep 20, 2023
Merged
mkdocs: Fix numbered code annotations #684
llucax
merged 2 commits into
frequenz-floss:v0.x.x
from
llucax:fix-numbered-annotations
Sep 20, 2023
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
daniel-zullo-frequenz
previously approved these changes
Sep 19, 2023
shsms
previously approved these changes
Sep 20, 2023
Sadly, it seems like numbered annotations are not officially supported anymore, so let's see how this evolve. If they break again I guess we are better off avoid its use, unless we can have a CSS guru to look into it. |
There was a regression introduced in `mkdocs-material` that broke how numbered annotations were rendered. See this issue for details: squidfunk/mkdocs-material#6042 This commit adds a style to make them look reasonably well again. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Now that scripts were moved to `docs/_scripts` the `labeler.yml` file must be updated too. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
d6195b9
ae518cb
to
d6195b9
Compare
I updated the PR to have all this in the CSS comment, so if future us see this breaks, we would have more context to decide what to do. |
shsms
approved these changes
Sep 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
part:docs
Affects the documentation
part:tooling
Affects the development tooling (CI, deployment, dependency management, etc.)
type:bug
Something isn't working
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.
There was a regression introduced in
mkdocs-material
that broke how numbered annotations were rendered. See this issue for details:This commit adds a style to make them look reasonably well again.
This also fix the labeler configuration to properly label scripts in the
docs/
directory.