zensical

.github/workflows/validation.yml

@@ -45,7 +45,7 @@ jobs:
         run: uv run npm run pylint
 
       - name: validate docs
-        run: uv run mkdocs build --strict
+        run: uv run zensical build --strict
 
   tests:
     strategy:

.gitignore

@@ -143,5 +143,5 @@ basedpyright/package.json
 # typeshed stubs with docstrings
 docstubs
 
-# mkdocs output
+# zensical output
 site/

mkdocs.yml

@@ -57,6 +57,7 @@ plugins:
   - search
   - awesome-pages
   # https://github.com/wilhelmer/mkdocs-unused-files/issues/12
+  # TODO: figure out if this is also an issue in zensical once it supports this https://github.com/zensical/backlog/issues/6
   # - unused_files
   - macros:
       module_name: build/py_latest/docs_macros

package.json

@@ -27,7 +27,7 @@
         "test-python": "uv run --no-sync pytest tests",
         "generate-docstubs": "uv run --no-sync build/py3_8/generate_docstubs.py",
         "localization-helper": "uv run --no-sync build/py_latest/localization_helper.py",
-        "docs": "uv run --no-sync mkdocs serve --livereload",
+        "docs": "uv run --no-sync zensical serve",
         "docs:fast": "npm run docs -- --dirty",
         "lsp-inspect": "uv run --no-sync lsp-devtools inspect",
         "lsp-client": "uv run --no-sync lsp-devtools client -- node packages/pyright/langserver.index.js --stdio"

pyproject.toml

@@ -32,13 +32,11 @@ dev = [
     "typing_extensions>=4.12.2",
     "pytest>=8.2.2",
     "pytest-github-actions-annotate-failures>=0.2.0",
-    "mkdocs-material>=9.5.37",
-    "mkdocs-awesome-pages-plugin>=2.9.2",
     "mike>=2.1.3",
-    "mkdocs-macros-plugin>=1.2.0",
     "lsp-devtools>=0.2.3",
     "pygls<2",                                        # transitive dependency of lsp-devtools. see https://github.com/microsoft/vscode-pylint/issues/626
     "zizmor>=1.2.0",
+    "zensical>=0.0.2",
 ]
 docstubs = [
     # these deps are also needed in build-system.requires. see https://github.com/pdm-project/pdm/issues/2947
@@ -74,6 +72,9 @@ default-groups = ["dev", "docstubs", "lochelper"]
 no-build-package = ["libcst"]
 exclude-newer = "1 week"
 
+[tool.uv.sources]
+mike = { git = "https://github.com/squidfunk/mike.git" }
+
 [tool.pdm.version]
 source = "call"
 getter = "build.py3_8.version:get"