docs(mkdocs): migrating documentation engine

.gitignore

@@ -68,8 +68,8 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
+# mkdocs documentation
+site/
 
 # PyBuilder
 .pybuilder/

.makim.yaml

@@ -25,7 +25,7 @@ groups:
         help: Build documentation
         run: |
           rm -rf docs/_build
-          jupyter-book build docs
+          mkdocs build
 
       preview:
         help: Preview documentation page locally

conda/dev.yaml

@@ -12,3 +12,4 @@ dependencies:
   - pip
   - pip:
       - makim==1.12.0
+      - paginate

mkdocs.yml

@@ -0,0 +1,65 @@
+theme:
+  name: material
+  features:
+    - navigation.sections
+  palette:
+    - scheme: default
+      primary: white
+      accent: amber
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+    - scheme: slate
+      primary: black
+      accent: amber
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
+  font:
+    text: Lato
+  icon:
+    repo: fontawesome/brands/github
+
+site_name: SciCookie
+site_description: Documentation for SciCookie
+site_author: OpenScienceLabs Team
+site_url: https://osl-incubator.github.io/scicookie
+
+repo_url: https://github.com/osl-incubator/scicookie
+repo_name: osl-incubator/scicookie
+edit_uri: ./edit/main/docs
+
+# strict: true
+
+plugins:
+  - search
+  - mkdocstrings
+  - autorefs # Cross-links to headings
+  - include_exclude_files:
+      exclude:
+        - "_overrides"
+
+markdown_extensions:
+  - callouts
+  - pymdownx.arithmatex
+  - pymdownx.magiclink
+  - pymdownx.details # Allowing hidden expandable regions denoted by ???
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.superfences # Seems to enable syntax highlighting when used with the Material theme.
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.snippets:
+      check_paths: true
+  - toc:
+      permalink: "¤" # Adds a clickable permalink to each section heading
+      toc_depth: 4
+
+docs_dir: docs
+
+nav:
+  - Home: "index.md"
+  - Guide: "guide.md"
+  - Contributing: "contributing.md"