doc: remove warnings about toc

mkdocs scans each .md file for unresolved links. The tableofcontent.md file, which is generated but not used in the doc (used only for copy/paste purposes) shouldn't be monitored by mkdocs => exclude it
georchestra · Feb 6, 2025 · 268fc34 · 268fc34
1 parent c0fd9a7
commit 268fc34
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -94,6 +94,9 @@ plugins:
         ignore_page_pattern: index.md
         remove_navigation_page_pattern: index.md
         template_dir_path: custom_template
+    - exclude:
+        glob:
+          - tableofcontent.md
     - i18n:
         docs_structure: suffix
         fallback_to_default: true

diff --git a/mkdocs_requirements.txt b/mkdocs_requirements.txt
@@ -16,6 +16,7 @@ mkdocs-material==9.5.14
 mkdocs-material-extensions==1.3.1
 mkdocs-callouts==1.13.2
 mkdocs-toc-md==0.0.9
+mkdocs-exclude==1.0.2
 mkdocs-git-revision-date-localized-plugin==1.2.4
 packaging==24.0
 paginate==0.5.6