Fix glossary links and restrict mkdocs-autorefs updates
#1043
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
llucax
requested review from
daniel-zullo-frequenz
and removed request for
a team
github-actions
bot
added
the
part:tooling
|
OK, pinning the dependency for now as it requires some work to fix proper. |
|
To fix this properly I think we need: |
shsms
reviewed
Aug 21, 2024
The links to the code symbols in the glossary were outdated, using old names from the logical meter. Signed-off-by: Leandro Lucarella <[email protected]>
It seems like `mkdocs` now also validates the anchor links in the documentation, and it was complaining about the broken links in the glossary. This commit fixes the broken links by changing the anchor names to lowercase and linking to the code where appropriate. Signed-off-by: Leandro Lucarella <[email protected]>
Version 1.1.0 will check for links that can resolve to multiple pages, and we have a few of those, which make the docs build fail. We will fix these in the future. Signed-off-by: Leandro Lucarella <[email protected]>
|
Updated to fix all of it. |
daniel-zullo-frequenz
approved these changes
Aug 21, 2024
shsms
approved these changes
Aug 21, 2024
llucax
changed the title
mkdocsmkdocs-autorefs updates
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.
No description provided.