migrate docs from Sphinx/RST to MkDocs Material

.github/workflows/docs.yml

@@ -15,7 +15,23 @@ jobs:
     if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v') || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved')
     runs-on: ubuntu-latest
     steps:
-      - uses: compas-dev/compas-actions.docs@v3
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          doc_url: https://compas.dev/compas
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          pip install -e .
+          pip install mkdocs mkdocs-material "mkdocstrings[python]"
+
+      - name: Build docs
+        run: mkdocs build --strict
+
+      - name: Deploy to GitHub Pages
+        if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v')
+        run: mkdocs gh-deploy --force
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.0.0
+    hooks:
+    - id: flake8
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+    - id: isort
+
+  - repo: https://github.com/ambv/black
+    rev: 23.3.0
+    hooks:
+    - id: black
+      language_version: python3.8
+

CHANGELOG.md

@@ -9,10 +9,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- MkDocs + Material theme based docs
+
 ### Changed
 
+- update CI workflow for mkdocs gh-deploy
+- update invoke tasks for mkdocs commands
+
 ### Removed
 
+- replace Sphinx with MkDocs + Material theme
+- use mkdocstrings for API docs from NumPy docstrings
+- convert 73 RST files to Markdown
+- remove RST directives from Python docstrings
 
 ## [2.15.0] 2025-11-12
 

docs/api/compas.colors.md

@@ -0,0 +1,7 @@
+# compas.colors
+
+Color handling for COMPAS.
+
+::: compas.colors
+    options:
+      show_submodules: true

docs/api/compas.data.md

@@ -0,0 +1,7 @@
+# compas.data
+
+Data serialization and persistence for COMPAS.
+
+::: compas.data
+    options:
+      show_submodules: true