Skip to content
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
merged 2 commits into from
Sep 20, 2023

Conversation

llucax
Copy link
Contributor

@llucax llucax commented Sep 19, 2023

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.

@llucax llucax requested a review from a team as a code owner September 19, 2023 14:30
@llucax llucax self-assigned this Sep 19, 2023
@github-actions github-actions bot added the part:docs Affects the documentation label Sep 19, 2023
@llucax llucax added the type:bug Something isn't working label Sep 19, 2023
@llucax llucax added this to the v1.0.0-rc2 milestone Sep 19, 2023
@llucax llucax added the part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) label Sep 19, 2023
@llucax llucax enabled auto-merge September 19, 2023 14:33
@llucax llucax added this pull request to the merge queue Sep 19, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 19, 2023
shsms
shsms previously approved these changes Sep 20, 2023
@llucax llucax added this pull request to the merge queue Sep 20, 2023
@llucax
Copy link
Contributor Author

llucax commented 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.

@llucax llucax removed this pull request from the merge queue due to a manual request Sep 20, 2023
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>
@llucax llucax dismissed stale reviews from shsms and daniel-zullo-frequenz via d6195b9 September 20, 2023 08:17
@llucax llucax force-pushed the fix-numbered-annotations branch from ae518cb to d6195b9 Compare September 20, 2023 08:17
@llucax
Copy link
Contributor Author

llucax commented Sep 20, 2023

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.

@llucax llucax added this pull request to the merge queue Sep 20, 2023
Merged via the queue into frequenz-floss:v0.x.x with commit bb0a34a Sep 20, 2023
@llucax llucax deleted the fix-numbered-annotations branch September 20, 2023 08:41
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
Projects
Development

Successfully merging this pull request may close these issues.

3 participants