From 5d8b166393c7515bdd43296700d32a6db2feacac Mon Sep 17 00:00:00 2001
From: Michel-FK <michel.stempin@funkey-project.com>
Date: Sat, 30 Jan 2021 11:03:30 +0100
Subject: [PATCH] add mkdocs-section-index and mkdocs-exclude plugins

Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
---
 .github/workflows/ci.yml                               |  2 ++
 docs/developers/hardware_ref/{design.md => index.md}   |  0
 .../software_ref/{architecture.md => index.md}         |  0
 docs/index.md                                          |  2 +-
 mkdocs.yml                                             | 10 ++++++++--
 5 files changed, 11 insertions(+), 3 deletions(-)
 rename docs/developers/hardware_ref/{design.md => index.md} (100%)
 rename docs/developers/software_ref/{architecture.md => index.md} (100%)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index a905917..b3e5327 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -13,4 +13,6 @@ jobs:
           python-version: 3.x
       - run: pip install mkdocs-material
       - run: pip install mkdocs-minify-plugin
+      - run: pip install mkdocs-section-index
+      - run: pip install mkdocs-exclude
       - run: mkdocs gh-deploy --force --remote-branch master
diff --git a/docs/developers/hardware_ref/design.md b/docs/developers/hardware_ref/index.md
similarity index 100%
rename from docs/developers/hardware_ref/design.md
rename to docs/developers/hardware_ref/index.md
diff --git a/docs/developers/software_ref/architecture.md b/docs/developers/software_ref/index.md
similarity index 100%
rename from docs/developers/software_ref/architecture.md
rename to docs/developers/software_ref/index.md
diff --git a/docs/index.md b/docs/index.md
index b9941fa..ed6e88c 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -36,7 +36,7 @@ Last but not least, this documentation would not be complete without a
 
 [1]: quickstart.md
 [2]: tutorials/software/update.md
-[3]: developers/hardware_ref/design.md
+[3]: developers/hardware_ref/
 [4]: developers/software_ref/disk_mapping/recovery.md
 [5]: miscellaneous/glossary.md
 [6]: miscellaneous/faq.md
diff --git a/mkdocs.yml b/mkdocs.yml
index 7162375..ee4ca3f 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -38,8 +38,14 @@ theme:
 # Plugins
 plugins:
   - search
+  - section-index
   - minify:
       minify_html: true
+  - exclude:
+      glob:
+        - tutorials/hardware/force_shutdown.md
+        - tutorials/software/restore_games.md
+        - tutorials/software/themes.md
 
 # Customization
 extra:
@@ -144,7 +150,7 @@ nav:
        # - 'Force shutdown': 'tutorials/hardware/force_shutdown.md'
   - Developer's Guide:
     - Hardware reference:
-      - 'Design' : 'developers/hardware_ref/design.md'
+      - 'developers/hardware_ref/index.md'
       - 'Architecture': 'developers/hardware_ref/architecture.md'
       - 'BOM': 'https://htmlpreview.github.io/?https://github.com/FunKey-Project/FunKey-S-Hardware/blob/master/BOM/ibom.html'
       - 'CPU': 'developers/hardware_ref/cpu.md'
@@ -162,7 +168,7 @@ nav:
       - 'UART': 'developers/hardware_ref/uart.md'
       - 'Magnetic Switch': 'developers/hardware_ref/magnetic_switch.md'
     - Software reference:
-      - 'Software Architecture': 'developers/software_ref/architecture.md'
+      - 'developers/software_ref/index.md'
       - Boot process:
         - 'Introduction': 'developers/software_ref/boot_process/boot_process_intro.md'
         - 'Bootloader': 'developers/software_ref/boot_process/bootloader.md'