chore: added install for mkdocs insiders (#1481)

Author: jjmachan

.readthedocs.yml

@@ -6,15 +6,6 @@ build:
     python: "3.12"
   commands:
     - pip install -e .[docs]
+    - if [ -n "$GH_TOKEN" ]; then pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git; fi
     - python scripts/gen_ref_pages.py
-    - mkdocs build --site-dir $READTHEDOCS_OUTPUT/html
-
-# mkdocs:
-#   configuration: mkdocs.yml
-
-# python:
-#   install:
-#     - method: pip
-#       path: .
-#       extra_requirements:
-#         - docs
+    - mkdocs build --site-dir $READTHEDOCS_OUTPUT/html

mkdocs.yml

@@ -108,10 +108,10 @@ nav:
   - ❤️ Community: community/index.md
 
 # https://www.mkdocs.org/user-guide/configuration/#validation
-# validation:
-#   omitted_files: warn
-#   absolute_links: warn
-#   unrecognized_links: warn
+validation:
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
 
 # Material-Docs Theme
 theme:
@@ -216,16 +216,16 @@ plugins:
             signature_crossrefs: true
   - mkdocs-jupyter:
       execute: false
-      # include: ["*.ipynb"]
-      ignore: ["*.md", "*.ipynb"]
+      include: ["*.ipynb"]
+      ignore: ["*.md"]
       jupyter_options:
         hide_input: false
         hide_output: false
         code_folding: true
         code_line_numbers: true
         jupyter_images: true
         jupyter_table_beautifier: true
-  # - glightbox
+  - glightbox
 
 extra_javascript:
   - _static/js/mathjax.js