Skip to content

Commit 7834896

Browse files
committed
Replace the section-index plugin with navigation.indexes
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 <[email protected]>
1 parent 75c257e commit 7834896

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@
1414

1515
## Bug Fixes
1616

17-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
17+
- Fix the **API Reference** link in the documentation website navigation bar.

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ theme:
2424
features:
2525
- content.code.annotate
2626
- content.code.copy
27+
- navigation.indexes
2728
- navigation.instant
2829
- navigation.tabs
2930
- navigation.top
@@ -115,7 +116,6 @@ plugins:
115116
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
116117
- https://watchfiles.helpmanual.io/objects.inv
117118
- search
118-
- section-index
119119

120120
# Preview controls
121121
watch:

0 commit comments

Comments
 (0)