Fix mkdocs navigation bar API link #642
Merged
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: Leandro Lucarella <luca-frequenz@llucax.com>
llucax
requested review from
daniel-zullo-frequenz
and removed request for
a team
github-actions
bot
added
part:docs
llucax
force-pushed
the
workaround-mkdocs
branch
from
3cf6c77 to
56ceb32
Compare
daniel-zullo-frequenz
previously approved these changes
Sep 7, 2023
matthias-wende-frequenz
previously approved these changes
Sep 8, 2023
The `section-index` plugin has a bug[^1] that causes the navigation bar to display a wrong text for the **API Reference** link. There is a fix for it, but `mkdocs-material` already provides the feature natively[^2], so we can just use it instead, as it is much less likely to have issues. [^1]: oprypin/mkdocs-section-index#18 [^2]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
llucax
dismissed stale reviews from matthias-wende-frequenz and daniel-zullo-frequenz
via
51382d4
llucax
force-pushed
the
workaround-mkdocs
branch
from
56ceb32 to
51382d4
Compare
daniel-zullo-frequenz
approved these changes
Sep 8, 2023
|
Updated with a final fix instead of a workaround. |
Yeah, it is, you can also look at the docs-site artifact from the Test documentation website generation job to see if it renders properly. It's a bit of work but it is an option :) Merging. |
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.
The
section-indexplugin has a bug1 that causes the navigation bar to display a wrong text for the API Reference link. There is a fix for it, butmkdocs-materialalready provides the feature natively2, so we can just use it instead, as it is much less likely to have issues.Footnotes
https://github.com/oprypin/mkdocs-section-index/issues/18 ↩
https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
Fixes The API documentation now is called "sdk" in the top navigation bar #640. ↩