Skip to content

Commit

Permalink
Replace the section-index plugin with navigation.indexes
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
llucax committed Sep 8, 2023
1 parent 75c257e commit 7834896
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@

## Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
- Fix the **API Reference** link in the documentation website navigation bar.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ theme:
features:
- content.code.annotate
- content.code.copy
- navigation.indexes
- navigation.instant
- navigation.tabs
- navigation.top
Expand Down Expand Up @@ -115,7 +116,6 @@ plugins:
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
- https://watchfiles.helpmanual.io/objects.inv
- search
- section-index

# Preview controls
watch:
Expand Down

0 comments on commit 7834896

Please sign in to comment.