feat: switch from mkdocs and mkdocs-theme material to properdocs with theme materialx

mkdocs and mkdocs-theme material are no longer supported, properdocs and materialx are drop-in replacements

Author: dornech

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
       - id: check-toml
       - id: check-xml
       - id: check-yaml
-        args: [ '--unsafe' ]  # needed for !! tags in mkdocs.yml
+        args: [ '--unsafe' ]  # needed for !! tags in mkdocs.yml / properdocs.yml
       - id: end-of-file-fixer
         exclude: CHANGELOG.md
       - id: mixed-line-ending

mkdocs.yml properdocs.ymlmkdocs.yml renamed to properdocs.yml

@@ -25,7 +25,7 @@ nav:
 docs_dir: docs
 site_dir: site
 theme:
-  name: material
+  name: materialx
   language: en
   favicon: assets/images/favicon.svg
   icon:

pyproject.toml

@@ -285,10 +285,10 @@ exclude_lines = [
 
 # Hatch default environment
 [tool.hatch.envs.default]
-# python = "3.9"
 post-install-commands = ["pre-commit install", "pre-commit install --hook-type commit-msg"]
 dependencies = [
     "pre-commit",
+    "pre_commit",
     "commitizen",
 ]
 # installer = "pip"
@@ -322,12 +322,12 @@ dependencies = [
 [tool.hatch.envs.test.scripts]
 cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=src/utils_COMobjects --cov=tests {args}"
 no-cov = "cov --no-cov {args}"
-debug =  "cov --no-cov -s --pdb --pdbcls=IPython.core.debugger:Pdb {args}"
+debug = "cov --no-cov -s --pdb --pdbcls=IPython.core.debugger:Pdb {args}"
 
 # Hatch testing environment matrix for various Python versions replacing the functionality of tox
 [[tool.hatch.envs.test.matrix]]
 template = ["test"]
-python = ["3.9", "3.10", "3.11", "3.12", "3.13"]
+python = ["3.10", "3.11", "3.12", "3.13", "3.14"]
 
 # Hatch default linting environment for "hatch fmt"
 [tool.hatch.envs.hatch-static-analysis]
@@ -370,8 +370,10 @@ all = [
 # Hatch environment for building documentation
 [tool.hatch.envs.docs]
 dependencies = [
-    "mkdocs~=1.6",
-    "mkdocs-material[imaging]~=9.4",
+    "pre-commit",  # needed otherwise error
+    "pre_commit",  # needed otherwise error
+    "properdocs",
+    "mkdocs-materialx[imaging]",
     # Plugins
     "mkdocs-include-markdown-plugin",
     "mkdocs-gen-files",
@@ -393,10 +395,10 @@ dependencies = [
 [tool.hatch.envs.docs.env-vars]
 SOURCE_DATE_EPOCH = "1580601600"
 PYTHONUNBUFFERED = "1"
-MKDOCS_CONFIG = "mkdocs.yml"
+MKDOCS_CONFIG = "properdocs.yml"
 [tool.hatch.envs.docs.scripts]
-build = "mkdocs build --config-file {env:MKDOCS_CONFIG} --clean --strict {args}"
-serve = "mkdocs serve --config-file {env:MKDOCS_CONFIG} --dev-addr localhost:8000 {args}"
+build = "properdocs build --config-file {env:MKDOCS_CONFIG} --clean --strict {args}"
+serve = "properdocs serve --config-file {env:MKDOCS_CONFIG} --dev-addr localhost:8000 {args}"
 ci-build = "mike deploy --config-file {env:MKDOCS_CONFIG} --update-aliases {args}"
 # --ignore-url=None since the SUMMARY.md file leaves a <toc>None</toc> in sitemap.xml
 validate = "linkchecker --config .linkcheckerrc --ignore-url=/reference --ignore-url=None site"