Merge branch 'main' into ironing_out_off

Author: tsmbland

.github/actions/generate-docs/action.yml

@@ -1,5 +1,9 @@
 name: Generate documentation
 description: Generate all documentation
+inputs:
+  build:
+    description: Just subcommand for `build-docs` to run
+    default: all
 
 runs:
   using: composite
@@ -18,4 +22,4 @@ runs:
         enable-cache: true
     - name: Build documentation
       shell: bash
-      run: just build-docs
+      run: just build-docs::${{ inputs.build }}

.github/dependabot.yml

@@ -9,7 +9,13 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      rust:
+        patterns: ["*"]
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      github-actions:
+        patterns: ["*"]

.github/workflows/deploy-docs.yml

@@ -23,7 +23,17 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v6
+        with:
+          fetch-tags: true
+          fetch-depth: 0
+      - name: Set user name and email for git
+        run: |
+          # Needed so we can apply patches
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
       - uses: ./.github/actions/generate-docs
+        with:
+          build: all_with_old
       - name: Setup pages
         uses: actions/configure-pages@v5
       - name: Upload artifact

.github/workflows/pre-commit-autoupdate.yml

@@ -16,9 +16,10 @@ jobs:
       - uses: actions/checkout@v6
         with:
           persist-credentials: false
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
       - uses: browniebroke/pre-commit-autoupdate-action@main
-      - uses: peter-evans/create-pull-request@v7
+      - uses: peter-evans/create-pull-request@v8
         with:
           token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
           branch: update/pre-commit-hooks

.lycheeignore

@@ -1,5 +1,6 @@
 # For some reason these spurious links appear in some cargo doc-generated files
 ^file://.+/MUSE2/book/api/index\.html$
+^file://.+/MUSE2/book/README\.html$
 
 # Some of these links give a 404, even though they're generated in the API docs. No idea why.
 ^https://docs.rs/erased-serde/

.pre-commit-config.yaml

@@ -31,7 +31,7 @@ repos:
         files: /settings\.toml$
         types_or: [toml]
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.47.0
+    rev: v0.48.0
     hooks:
       - id: markdownlint-fix
   - repo: https://github.com/pre-commit/mirrors-prettier
@@ -53,7 +53,7 @@ repos:
       - id: clippy
         args: ["--all-targets", "--", "-D", "warnings"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.4
+    rev: v0.15.6
     hooks:
       - id: ruff-check
         types_or: [python]
@@ -65,12 +65,12 @@ repos:
     hooks:
       - id: nbstripout
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.4.1
+    rev: v2.4.2
     hooks:
       - id: codespell
         args: [--ignore-words, .codespell_ignore.txt]
         exclude: \.svg$
-  - repo: https://github.com/citation-file-format/cffconvert
-    rev: b6045d78aac9e02b039703b030588d54d53262ac
+  - repo: https://github.com/EnergySystemsModellingLab/cffconvert
+    rev: 2.1.0
     hooks:
       - id: validate-cff

.python-version

@@ -0,0 +1 @@
+3.12

Cargo.lock

@@ -19,8 +19,8 @@ float-cmp = "0.10.0"
 itertools = "0.14.0"
 serde = {version = "1.0.228", features = ["derive", "rc"]}
 serde_string_enum = "0.2.1"
-tempfile = "3.26.0"
-toml = "1.0.3"
+tempfile = "3.27.0"
+toml = "1.0.6"
 unicase = "2.9.0"
 fern = {version = "0.7.1", features = ["chrono", "colored"]}
 chrono = "0.4"
@@ -37,10 +37,10 @@ strum = {version = "0.28.0", features = ["derive"]}
 documented = "0.9.2"
 dirs = "6.0.0"
 edit = "0.1.5"
-erased-serde = "0.4.9"
+erased-serde = "0.4.10"
 
 [dev-dependencies]
-assert_cmd = "2.1.2"
+assert_cmd = "2.2.0"
 map-macro = "0.3.0"
 rstest = {version = "0.26.1", default-features = false, features = ["crate-name"]}
 yaml-rust2 = {version = "0.11.0", default-features = false}

Cargo.toml

@@ -1,8 +1,11 @@
 # Make rustdoc warnings fatal
 export RUSTDOCFLAGS := "-D warnings"
 
-# Build all documentation
-all: cli-help file-format examples book api
+# Build all documentation, except old docs
+all: cli-help file-format examples versions book api
+
+# Build all documentation, including old docs
+all_with_old: all old
 
 # Build book
 book:
@@ -33,3 +36,15 @@ file-format *ARGS:
 examples:
     @echo Building docs for examples
     @uv run docs/generate_example_docs.py
+
+# Build TOC for old versions
+versions:
+    @echo Building TOC for old versions of documentation
+    @uv run docs/generate_versions_docs.py
+
+# Build documentation for previous releases
+old:
+    @# Clean output dir
+    @rm -rf book/release
+
+    @uv run docs/build_old_docs.py