Add material theme to the docs

Signed-off-by: Fabrice Normandin <[email protected]>
mila-iqia · Jul 2, 2024 · 24f518b · 24f518b
1 parent 443632b
commit 24f518b
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 8 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -3,7 +3,7 @@ site_description: A project template and directory structure for Python data sci
 site_url: https://mila-iqia.github.io/ResearchTemplate/
 repo_url: https://www.github.com/mila-iqia/ResearchTemplate
 # edit_uri: edit/master/docs
-theme: readthedocs
+theme: material
 # nav:
 #   - Home: index.md
 #   # see https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin?tab=readme-ov-file#rest

diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -64,6 +64,7 @@ dev = [
     "black>=24.4.2",
     "mkdocs-awesome-pages-plugin>=2.9.2",
     "mkdocs-literate-nav>=0.6.1",
+    "mkdocs-material>=9.5.28",
 ]
 
 [[tool.pdm.source]]