Migrate to Materialx/Properdocs

.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true -diff

.gitignore

@@ -19,3 +19,6 @@ site/*
 
 # Mac stuff
 .DS_Store
+# pixi environments
+.pixi/*
+!.pixi/config.toml

.readthedocs.yaml

@@ -9,11 +9,15 @@ version: 2
 build:
   os: ubuntu-24.04
   tools:
-    python: "3.10"
+    python: "3.14"
+  jobs:
+    create_environment:
+      - asdf plugin add pixi
+      - asdf install pixi latest
+      - asdf global pixi latest
+    install:
+      - pixi install
+    build:
+      html:
+        - pixi run properdocs build -d $READTHEDOCS_OUTPUT/html
 
-mkdocs:
-  configuration: mkdocs.yml
-
-python:
-  install:
-    - requirements: requirements.txt

README.md

@@ -2,18 +2,21 @@
 
 Hosted on [Read the docs](https://bsu-docs.readthedocs.io/en/latest/)
 
-Built using [MkDocs](https://www.mkdocs.org/)
+Built using [Properdocs](https://properdocs.org")
 
-Uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme
+Uses [MaterialX](https://jaywhj.github.io/mkdocs-materialx/) theme
 
 ## To build locally
 
-1. Create a python environment containing the packages in requirements.txt.
-We recommend using [mambaforge](https://mamba.readthedocs.io/en/latest/installation.html).
+1. Install [pixi](https://pixi.prefix.dev/latest/)
 
-2. Build the site and start the docs server:
+2. Create the python environment described in `pixi.toml`:
+```bash
+pixi install
+```
+
+3. Build the site and start the docs server:
 
 ```bash
-mkdocs build
-mkdocs serve
+pixi run properdocs serve -o
 ```

docs/stylesheets/extra.css

@@ -1,8 +1,12 @@
 [data-md-color-scheme="default"] {
   --md-primary-fg-color: #0033A0;
+  --md-primary-fg-color--light: #0033A0;
+  --md-primary-fg-color--dark: #0033A0;
   --md-code-hl-color: #99C5ff;
 }
 [data-md-color-scheme="slate"] {
   --md-primary-fg-color: #0033A0;
+  --md-primary-fg-color--light: #0033A0;
+  --md-primary-fg-color--dark: #0033A0;
   --md-typeset-a-color: #4C9AFF;
 }

pixi.toml

@@ -0,0 +1,16 @@
+[workspace]
+authors = ["Jenny Fothergill <jennyfothergill@boisestate.edu>"]
+channels = ["conda-forge"]
+name = "docs"
+platforms = ["osx-arm64", "linux-64"]
+version = "0.1.0"
+
+[tasks]
+
+[dependencies]
+python = ">=3.14.7,<3.15"
+pygments = ">=2.21.0,<3"
+
+[pypi-dependencies]
+mkdocs-materialx = ">=10.2.0, <11"
+properdocs = ">=1.6.7, <2"

mkdocs.yml → properdocs.yml

@@ -37,9 +37,10 @@ theme:
     - navigation.instant
     - navigation.sections
     - toc.integrate
-  name: material
+  name: materialx
   logo: images/boisestate-B-1color-orange-rgb.png
   favicon: images/boisestate-B-1color-orange-rgb.png
+  topbar_style: primary
   palette:
   - scheme: default
     toggle: