chore(docs): replace mkdocs with zensical

.github/workflows/docs.yml

@@ -26,5 +26,5 @@ jobs:
           make init-uv
           make install
 
-      - name: "Build mkdocs"
+      - name: "Build and deploy docs"
         run: make doc-deploy

.gitignore

@@ -138,7 +138,7 @@ venv.bak/
 # Rope project settings
 .ropeproject
 
-# mkdocs documentation
+# zensical documentation
 /site
 
 # mypy

Makefile

@@ -12,13 +12,13 @@ clean:
 
 # Docs
 doc-build:
-	uv run mkdocs build
+	uv run zensical build
 
-doc-serve: doc-build
-	uv run mkdocs serve
+doc-serve:
+	uv run zensical serve
 
-doc-deploy:
-	uv run mkdocs gh-deploy --force
+doc-deploy: doc-build
+	uv run ghp-import -n -p -f site
 
 # Setup
 init: init-uv init-python

README.md

@@ -6,7 +6,7 @@
 Sample structure and setup for a Python project which includes:
 
 * prek hooks (static formatters and type checking)
-* mkdoc generation from docstrings
+* doc generation from docstrings (via [zensical](https://zensical.org/))
 * unittest execution
 
 ## Installation

pyproject.toml

@@ -23,10 +23,9 @@ df = [
 
 [dependency-groups]
 dev = [
+    "ghp-import >=2.1.0,<3",
     "interrogate >=1.7.0,<2",
-    "mkdocs >=1.6.0,<2",
-    "mkdocs-material >=9.4.5,<10",
-    "mkdocstrings[python] >=0.25.2,<1",
+    "mkdocstrings-python >=1.16.0,<3",
     "nox >=2024.4.15,<2025",
     "prek >=0.1.0,<1",
     "pyrefly >=1.2.0,<2",
@@ -35,6 +34,7 @@ dev = [
     "python-semantic-release >=10.0.0,<11",
     "ruff >=0.6.2,<1",
     "sqlfluff >=3.1.1,<4",
+    "zensical >=0.0.60,<0.1 ; python_version >= '3.10'",
 ]