Migrates docs tooling to zensical and improves API navigation

.github/workflows/docs.yml

@@ -29,10 +29,10 @@ jobs:
           cache-dependency-path: "pyproject.toml"
 
       - name: Install tox
-        run: python -m pip install tox
+        run: python -m pip install tox tox-uv
 
       - name: Build HTML documentation with tox
-        run: tox -e docs
+        run: tox r -e docs
 
       - name: Upload built docs as artifact
         id: deployment

.github/workflows/tests.yml

@@ -36,7 +36,7 @@ jobs:
           cache-dependency-path: pyproject.toml
 
       - name: Install dependencies
-        run: python -m pip install tox tox-gh
+        run: python -m pip install tox tox-gh tox-uv
 
       - name: Test with tox
         run: tox run

.pre-commit-config.yaml

@@ -14,10 +14,6 @@ repos:
     rev: v1.5.5
     hooks:
       - id: forbid-tabs
-  - repo: https://github.com/pappasam/toml-sort
-    rev: v0.24.2
-    hooks:
-      - id: toml-sort-fix
   # - repo: https://github.com/pre-commit/mirrors-mypy
   #   rev: v1.16.1
   #   hooks:

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "python-envs.defaultEnvManager": "ms-python.python:venv",
+  "python-envs.pythonProjects": []
+}

docs/api/analysis/bootstrap.md

@@ -1,6 +1,8 @@
+---
+icon: lucide/arrow-up-wide-narrow
+---
 # Bootstrap
 
 ::: circumplex.analysis.bootstrap
     options:
         heading_level: 2
-:::

docs/api/analysis/corr_analysis.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/chart-scatter
+---
+
 # Correlation Analysis
 
 ::: circumplex.analysis.corr_analysis
     options:
         heading_level: 2
-:::

docs/api/analysis/mean_analysis.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/diff
+---
+
 # Mean Analysis
 
 ::: circumplex.analysis.mean_analysis
     options:
         heading_level: 2
-:::

docs/api/analysis/ssm_analyze.md

@@ -1,6 +1,9 @@
+---
+icon: material/sine-wave
+---
+
 # SSM Analysis
 
 ::: circumplex.analysis.ssm_analyze
     options:
         heading_level: 2
-:::

docs/api/core/parameters.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/variable
+---
+
 # Parameters
 
 ::: circumplex.core.parameters
     options:
         heading_level: 2
-:::

docs/api/core/scores.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/file-digit
+---
+
 # Scores
 
 ::: circumplex.core.scores
     options:
         heading_level: 2
-:::

docs/api/data.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/layers
+---
+
 # Data
 
 ::: circumplex.data
     options:
         heading_level: 2
-:::

docs/api/index.md

@@ -4,4 +4,3 @@
     options:
       heading_level: 2
       members: []
-:::

docs/api/models.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/package
+---
+
 # Instrument Models
 
 ::: circumplex.instruments.models
     options:
         heading_level: 2
-:::

docs/api/plots.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/bolt
+---
+
 # Plots
 
 ::: circumplex.visualization.plots
     options:
         heading_level: 2
-:::

docs/api/ssm.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/form
+---
+
 # SSM Results
 
 ::: circumplex.ssm
     options:
         heading_level: 2
-:::

docs/api/utils/angles.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/chart-pie
+---
+
 # Angles
 
 ::: circumplex.utils.angles
     options:
         heading_level: 2
-:::

docs/api/utils/contrast.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/git-compare-arrows
+---
+
 # Contrast
 
 ::: circumplex.utils.contrast
     options:
         heading_level: 2
-:::

docs/api/utils/tidying_functions.md

@@ -1,6 +1,9 @@
+---
+icon: lucide/brush-cleaning
+---
+
 # Tidying Functions
 
 ::: circumplex.utils.tidying_functions
     options:
         heading_level: 2
-:::