Migrate docs to material for mkdocs

ckan · Nov 8, 2024 · 1a3667f · 1a3667f
1 parent b56edaa
commit 1a3667f
Show file tree

Hide file tree

Showing 25 changed files with 1,219 additions and 1,440 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -8,18 +8,14 @@ version: 2
 # Set the version of Python and other tools you might need
 build:
   os: ubuntu-22.04
-  apt_packages:
-      - libmagic-dev
   tools:
-    python: "3.10"
+    python: "3.12"
 
-sphinx:
-  configuration: doc/conf.py
+mkdocs:
+  configuration: mkdocs.yml
 
 formats: all
 
 python:
   install:
-    - method: pip
-      path: .
-    - requirements: doc-requirements.txt
+  - requirements: docs/requirements.txt
diff --git a/doc-requirements.txt b/doc-requirements.txt
diff --git a/doc/_assets/ckan.ico b/doc/_assets/ckan.ico
diff --git a/doc/_assets/logo.png b/doc/_assets/logo.png
diff --git a/doc/_css/extra.css b/doc/_css/extra.css
@@ -0,0 +1,27 @@
+[data-md-color-scheme="ckan"] {
+  --md-primary-fg-color:        #2980b9;
+  --md-primary-fg-color--light: #ECB7B7;
+  --md-primary-fg-color--dark:  #90030C;
+}
+
+[data-md-color-scheme="slate"] {
+  --md-primary-fg-color:        #2980b9;
+  --md-primary-fg-color--light: #ECB7B7;
+  --md-primary-fg-color--dark:  #90030C;
+  --md-hue: 210;
+}
+
+
+[data-md-toggle="search"]:not(:checked) ~ .md-header .md-search__form::after {
+  position: absolute;
+  top: .3rem;
+  right: .3rem;
+  display: block;
+  padding: .1rem .4rem;
+  color: var(--md-default-bg-color);
+  font-weight: bold;
+  font-size: .8rem;
+  border: .05rem solid var(--md-default-bg-color--lighter);
+  border-radius: .1rem;
+  content: "/";
+}
diff --git a/doc/_static/index.png b/doc/_static/index.png
diff --git a/doc/_templates/footer.html b/doc/_templates/footer.html
diff --git a/doc/changelog.md b/doc/changelog.md
@@ -0,0 +1 @@
+--8<-- "CHANGELOG.md"
diff --git a/doc/conf.py b/doc/conf.py