Skip to content

Upgrade the documentation to Documenter 1 - #360

Merged
andreasnoack merged 1 commit into
masterfrom
an/documenter-1
Nov 13, 2026
Merged

andreasnoack merged 1 commit into
masterfrom
an/documenter-1

Conversation

@andreasnoack

Copy link
Copy Markdown
Member

Set Documenter = "1" in docs/Project.toml and adapt docs/make.jl: Documenter 1 removed the strict keyword of makedocs and treats all checks as errors by default, so strict = Documenter.except(:missing_docs) becomes warnonly = [:missing_docs].

This is the manual part of the Documenter bump that Dependabot proposes in #358, where the docs build fails with "makedocs() got passed invalid keyword arguments: strict".

No other changes were needed. Building locally with Documenter 1.20, all stages pass except two doctests in temporal_terms.md. They fail there only because the build was run on Julia 1.13, which prints 5×3 Matrix{...} where the expected output (from the Julia 1.8 used by the docs workflow) has 5×3 reshape(::Matrix{...}, 5, 3) with eltype .... That is independent of the Documenter version.

This pull request was written by generative AI (Claude).

Documenter 1 removed the `strict` keyword of `makedocs`. Errors are now
the default, so use `warnonly = [:missing_docs]` to keep the previous
behavior of only tolerating missing docstrings.
@andreasnoack
andreasnoack merged commit 64c570c into master Nov 13, 2026
8 checks passed
@andreasnoack
andreasnoack deleted the an/documenter-1 branch November 13, 2026 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant