Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .github/actions/generate-docs/action.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
name: Generate documentation
description: Generate all documentation
inputs:
build:
description: Just subcommand for `build-docs` to run
default: all

runs:
using: composite
Expand All @@ -22,4 +18,4 @@ runs:
enable-cache: true
- name: Build documentation
shell: bash
run: just build-docs::${{ inputs.build }}
run: just build-docs
6 changes: 0 additions & 6 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,7 @@ updates:
directory: "/"
schedule:
interval: "weekly"
groups:
rust:
patterns: ["*"]
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
groups:
github-actions:
patterns: ["*"]
10 changes: 0 additions & 10 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,7 @@ 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
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/pre-commit-autoupdate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,9 @@ jobs:
- uses: actions/checkout@v6
with:
persist-credentials: false
- uses: actions/setup-python@v6
- uses: actions-rust-lang/setup-rust-toolchain@v1
- uses: actions/setup-python@v5
- uses: browniebroke/pre-commit-autoupdate-action@main
- uses: peter-evans/create-pull-request@v8
- uses: peter-evans/create-pull-request@v7
with:
token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
branch: update/pre-commit-hooks
Expand Down
1 change: 0 additions & 1 deletion .lycheeignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# 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/
Expand Down
10 changes: 5 additions & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ repos:
files: /settings\.toml$
types_or: [toml]
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.48.0
rev: v0.47.0
hooks:
- id: markdownlint-fix
- repo: https://github.com/pre-commit/mirrors-prettier
Expand All @@ -53,7 +53,7 @@ repos:
- id: clippy
args: ["--all-targets", "--", "-D", "warnings"]
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.15.5
rev: v0.15.4
hooks:
- id: ruff-check
types_or: [python]
Expand All @@ -65,12 +65,12 @@ repos:
hooks:
- id: nbstripout
- repo: https://github.com/codespell-project/codespell
rev: v2.4.2
rev: v2.4.1
hooks:
- id: codespell
args: [--ignore-words, .codespell_ignore.txt]
exclude: \.svg$
- repo: https://github.com/EnergySystemsModellingLab/cffconvert
rev: 2.1.0
- repo: https://github.com/citation-file-format/cffconvert
rev: b6045d78aac9e02b039703b030588d54d53262ac
hooks:
- id: validate-cff
18 changes: 9 additions & 9 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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.27.0"
toml = "1.0.6"
tempfile = "3.26.0"
toml = "1.0.3"
unicase = "2.9.0"
fern = {version = "0.7.1", features = ["chrono", "colored"]}
chrono = "0.4"
Expand All @@ -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.10"
erased-serde = "0.4.9"

[dev-dependencies]
assert_cmd = "2.2.0"
assert_cmd = "2.1.2"
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}
Expand Down
19 changes: 2 additions & 17 deletions build-docs.just
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# Make rustdoc warnings fatal
export RUSTDOCFLAGS := "-D warnings"

# 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 all documentation
all: cli-help file-format examples book api

# Build book
book:
Expand Down Expand Up @@ -36,15 +33,3 @@ 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
1 change: 0 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Generated documentation files
command_line_help.md
examples.md
versions.md
1 change: 0 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,3 @@
- [Release notes](release_notes/README.md)
- [MUSE2 v2.0.0 (October 14, 2025)](release_notes/v2.0.0.md)
- [Next unreleased version](release_notes/upcoming.md)
- [Other versions of documentation](versions.md)
86 changes: 0 additions & 86 deletions docs/build_old_docs.py

This file was deleted.

31 changes: 0 additions & 31 deletions docs/generate_versions_docs.py

This file was deleted.

Loading
Loading