Bump mkdocs and mkdocs-material versions, use mkdocs-material cards i…

…nstead of neoteroi-mkdocs
aai-institute · Jan 23, 2024 · 516f5cf · 516f5cf
1 parent f2f7466
commit 516f5cf
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 23 deletions.
diff --git a/docs/css/extra.css b/docs/css/extra.css
@@ -69,6 +69,7 @@ a.autorefs-external:hover::after {
 .nt-card-image:focus {
   filter: invert(32%) sepia(93%) saturate(1535%) hue-rotate(220deg) brightness(102%) contrast(99%);
 }
+
 .md-header__button.md-logo {
     padding: 0;
 }

diff --git a/docs/css/grid-cards.css b/docs/css/grid-cards.css
@@ -0,0 +1,23 @@
+/* Shadow */
+.grid.cards > ul > li {
+    box-shadow: 0 2px 2px 0 rgb(0 0 0 / 14%), 0 3px 1px -2px rgb(0 0 0 / 20%), 0 1px 5px 0 rgb(0 0 0 / 12%);
+
+    &:hover {
+        box-shadow: 0 2px 2px 0 rgb(0 0 0 / 24%), 0 3px 1px -2px rgb(0 0 0 / 30%), 0 1px 5px 0 rgb(0 0 0 / 22%);
+    }
+}
+
+[data-md-color-scheme="slate"] {
+    .grid.cards > ul > li {
+        box-shadow: 0 2px 2px 0 rgb(4 40 33 / 14%), 0 3px 1px -2px rgb(40 86 94 / 47%), 0 1px 5px 0 rgb(139 252 255 / 64%);
+
+        &:hover {
+            box-shadow: 0 2px 2px 0 rgb(0 255 206 / 14%), 0 3px 1px -2px rgb(33 156 177 / 47%), 0 1px 5px 0 rgb(96 251 255 / 64%);
+        }
+    }
+}
+
+/* Hover */
+.grid.cards > ul > li:hover p:first-child {
+    color: var(--md-accent-fg-color);
+}
diff --git a/docs/css/neoteroi.css b/docs/css/neoteroi.css
diff --git a/docs/getting-started/first-steps.md b/docs/getting-started/first-steps.md
@@ -1,11 +1,11 @@
 ---
-title: Getting Started
+title: First Steps
 alias: 
-  name: getting-started
-  text: Getting Started
+  name: first-steps
+  text: First Steps
 ---
 
-# Getting started
+# First Steps
 
 !!! Warning
     Make sure you have read [[installation]] before using the library. 

diff --git a/docs/index.md b/docs/index.md
@@ -9,26 +9,39 @@ It runs most of them in parallel either locally or in a cluster and supports
 distributed caching of results.
 
 If you're a first time user of pyDVL, we recommend you to go through the
-[[getting-started]] and [[installation]] guides.
+[[installation]] and [[first-steps]] guides in the Getting Started section.
 
-::cards:: cols=2
+<div class="grid cards" markdown>
 
-- title: Installation
-  content: Steps to install and requirements
-  url: getting-started/installation.md
+-   :fontawesome-solid-toolbox:{ .lg .middle } __Installation__
+
+    ---
+    Steps to install and requirements
+
+    [[installation|:octicons-arrow-right-24: Installation]]
+
+-   :fontawesome-solid-scale-unbalanced:{ .lg .middle } __Data valuation__
+
+    ---
 
-- title: Data valuation
-  content: >
     Basics of data valuation and description of the main algorithms
-  url: value/
 
-- title: Influence Function
-  content: >
+    [[data-valuation|:octicons-arrow-right-24: Data Valuation]]
+
+-   :fontawesome-solid-scale-unbalanced-flip:{ .lg .middle } __Influence Function__
+
+    ---
+
     An introduction to the influence function and its computation with pyDVL
-  url: influence/
 
-- title: Browse the API
-  content: Full documentation of the API
-  url: api/pydvl/
+    [[influence-values|:octicons-arrow-right-24: Influence Values]]
+
+-   :fontawesome-regular-file-code:{ .lg .middle } __API Reference__
+
+    ---
+
+    Full documentation of the API
+
+    [:octicons-arrow-right-24: API Reference](api/pydvl/)
 
-::/cards::
+</div>
diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -1,6 +1,6 @@
 mike
 markdown-captions
-mkdocs==1.5.2
+mkdocs==1.5.3
 mkdocstrings[python]>=0.18
 mkdocs-alias-plugin>=0.6.0
 mkdocs-autorefs
@@ -11,10 +11,9 @@ mkdocs-glightbox
 mknotebooks>=0.8.0
 pygments
 mkdocs-literate-nav
-mkdocs-material
+mkdocs-material>=9.5.0
 mkdocs-section-index
 mkdocs-macros-plugin
-neoteroi-mkdocs  # Needed for card grid on home page
 pypandoc; sys_platform == 'darwin'
 pypandoc_binary; sys_platform != 'darwin'
 GitPython