Replace section-indexes with navigation.indexes

llucax · llucax · commit f6b80b921707 · 2023-09-18T14:47:28.000+02:00
Use the native `navigation.indexes` extension from `mkdocs-material`
instead of the `section-indexes` plugin because the plugin had some
issues when failing to keep up to date.

Signed-off-by: Leandro Lucarella &lt;luca-frequenz@llucax.com&gt;
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -8,3 +8,6 @@
 
 - Update the generated version in dependencies.
 - Exclude `benchmarks/` directory from source distribution.
+- Use the native `navigation.indexes` extension from `mkdocs-material` instead of the `section-indexes` plugin.
+
+  The plugin had some issues when failing to keep up to date.
diff --git a/cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml b/cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml
@@ -27,6 +27,7 @@ theme:
   features:
     - content.code.annotate
     - content.code.copy
+    - navigation.indexes
     - navigation.instant
     - navigation.tabs
     - navigation.top
@@ -119,7 +120,6 @@ plugins:
 {%- endif %}
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   - search
-  - section-index
 
 # Preview controls
 watch:
diff --git a/cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml b/cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml
@@ -73,7 +73,6 @@ dev-mkdocs = [
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.0",
   "mkdocs-material == 9.1.21",
-  "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
   "frequenz-repo-config[{{cookiecutter.type}}] == 0.6.2",
 ]
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -24,6 +24,7 @@ theme:
   features:
     - content.code.annotate
     - content.code.copy
+    - navigation.indexes
     - navigation.instant
     - navigation.tabs
     - navigation.top
@@ -112,7 +113,6 @@ plugins:
             - https://sybil.readthedocs.io/en/stable/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   - search
-  - section-index
 
 # Preview controls
 watch:
diff --git a/pyproject.toml b/pyproject.toml
@@ -74,7 +74,6 @@ dev-mkdocs = [
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.0",
   "mkdocs-material == 9.1.21",
-  "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
 ]
 dev-mypy = [
diff --git a/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/mkdocs.yml b/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/mkdocs.yml
@@ -27,6 +27,7 @@ theme:
   features:
     - content.code.annotate
     - content.code.copy
+    - navigation.indexes
     - navigation.instant
     - navigation.tabs
     - navigation.top
@@ -114,7 +115,6 @@ plugins:
             - https://frequenz-floss.github.io/frequenz-sdk-python/v0.22/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   - search
-  - section-index
 
 # Preview controls
 watch:
diff --git a/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml
@@ -55,7 +55,6 @@ dev-mkdocs = [
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.0",
   "mkdocs-material == 9.1.21",
-  "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
   "frequenz-repo-config[actor] == 0.6.2",
 ]
diff --git a/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml b/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml
@@ -27,6 +27,7 @@ theme:
   features:
     - content.code.annotate
     - content.code.copy
+    - navigation.indexes
     - navigation.instant
     - navigation.tabs
     - navigation.top
@@ -114,7 +115,6 @@ plugins:
             - https://grpc.github.io/grpc/python/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   - search
-  - section-index
 
 # Preview controls
 watch:
diff --git a/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml
@@ -53,7 +53,6 @@ dev-mkdocs = [
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.0",
   "mkdocs-material == 9.1.21",
-  "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
   "frequenz-repo-config[api] == 0.6.2",
 ]
diff --git a/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/mkdocs.yml b/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/mkdocs.yml
@@ -27,6 +27,7 @@ theme:
   features:
     - content.code.annotate
     - content.code.copy
+    - navigation.indexes
     - navigation.instant
     - navigation.tabs
     - navigation.top
@@ -114,7 +115,6 @@ plugins:
             - https://frequenz-floss.github.io/frequenz-sdk-python/v0.22/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   - search
-  - section-index
 
 # Preview controls
 watch:
diff --git a/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml
@@ -54,7 +54,6 @@ dev-mkdocs = [
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.0",
   "mkdocs-material == 9.1.21",
-  "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
   "frequenz-repo-config[app] == 0.6.2",
 ]
diff --git a/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/mkdocs.yml b/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/mkdocs.yml
@@ -27,6 +27,7 @@ theme:
   features:
     - content.code.annotate
     - content.code.copy
+    - navigation.indexes
     - navigation.instant
     - navigation.tabs
     - navigation.top
@@ -112,7 +113,6 @@ plugins:
             - https://docs.python.org/3/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   - search
-  - section-index
 
 # Preview controls
 watch:
diff --git a/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml
@@ -51,7 +51,6 @@ dev-mkdocs = [
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.0",
   "mkdocs-material == 9.1.21",
-  "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
   "frequenz-repo-config[lib] == 0.6.2",
 ]
diff --git a/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/mkdocs.yml b/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/mkdocs.yml
@@ -27,6 +27,7 @@ theme:
   features:
     - content.code.annotate
     - content.code.copy
+    - navigation.indexes
     - navigation.instant
     - navigation.tabs
     - navigation.top
@@ -114,7 +115,6 @@ plugins:
             - https://frequenz-floss.github.io/frequenz-sdk-python/v0.22/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   - search
-  - section-index
 
 # Preview controls
 watch:
diff --git a/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml
@@ -55,7 +55,6 @@ dev-mkdocs = [
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.0",
   "mkdocs-material == 9.1.21",
-  "mkdocs-section-index == 0.3.5",
   "mkdocstrings[python] == 0.22.0",
   "frequenz-repo-config[model] == 0.6.2",
 ]

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,6 @@ dev-mkdocs = [`
`73`	`73`	`"mkdocs-gen-files == 0.5.0",`
`74`	`74`	`"mkdocs-literate-nav == 0.6.0",`
`75`	`75`	`"mkdocs-material == 9.1.21",`
`76`		`- "mkdocs-section-index == 0.3.5",`
`77`	`76`	`"mkdocstrings[python] == 0.22.0",`
`78`	`77`	`"frequenz-repo-config[{{cookiecutter.type}}] == 0.6.2",`
`79`	`78`	`]`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,6 @@ dev-mkdocs = [`
`74`	`74`	`"mkdocs-gen-files == 0.5.0",`
`75`	`75`	`"mkdocs-literate-nav == 0.6.0",`
`76`	`76`	`"mkdocs-material == 9.1.21",`
`77`		`- "mkdocs-section-index == 0.3.5",`
`78`	`77`	`"mkdocstrings[python] == 0.22.0",`
`79`	`78`	`]`
`80`	`79`	`dev-mypy = [`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,6 @@ dev-mkdocs = [`
`55`	`55`	`"mkdocs-gen-files == 0.5.0",`
`56`	`56`	`"mkdocs-literate-nav == 0.6.0",`
`57`	`57`	`"mkdocs-material == 9.1.21",`
`58`		`- "mkdocs-section-index == 0.3.5",`
`59`	`58`	`"mkdocstrings[python] == 0.22.0",`
`60`	`59`	`"frequenz-repo-config[actor] == 0.6.2",`
`61`	`60`	`]`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,6 @@ dev-mkdocs = [`
`53`	`53`	`"mkdocs-gen-files == 0.5.0",`
`54`	`54`	`"mkdocs-literate-nav == 0.6.0",`
`55`	`55`	`"mkdocs-material == 9.1.21",`
`56`		`- "mkdocs-section-index == 0.3.5",`
`57`	`56`	`"mkdocstrings[python] == 0.22.0",`
`58`	`57`	`"frequenz-repo-config[api] == 0.6.2",`
`59`	`58`	`]`