Repository navigation
Upgrade the documentation to Documenter 1 - #360
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Set
Documenter = "1"indocs/Project.tomland adaptdocs/make.jl: Documenter 1 removed thestrictkeyword ofmakedocsand treats all checks as errors by default, sostrict = Documenter.except(:missing_docs)becomeswarnonly = [: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 prints5×3 Matrix{...}where the expected output (from the Julia 1.8 used by the docs workflow) has5×3 reshape(::Matrix{...}, 5, 3) with eltype .... That is independent of the Documenter version.This pull request was written by generative AI (Claude).