Skip to content

Commit

Permalink
Update documentation settings for Documenter v1
Browse files Browse the repository at this point in the history
`Documenter.makedocs` now fails builds by default if any of the document checks fails.

Several docstrings are presently absent from this package, leading to build failures in Documenter. Although the ultimate goal remains to provide documentation for every exported function, this commit serves as a temporary workaround. It enables Documenter to issue warnings, rather than triggering errors, in instances of missing docstrings.

# See also
Release notes of Documenter v1:
<https://documenter.juliadocs.org/stable/release-notes/#Version-[v1.0.0](https://github.com/JuliaDocs/Documenter.jl/releases/tag/v1.0.0)-2023-09-15>
  • Loading branch information
matteorossini committed Nov 23, 2023
1 parent 9ba03ec commit 159c441
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ using Documenter, FlexPlan
makedocs(
modules = [FlexPlan],
sitename = "FlexPlan",
warnonly = :missing_docs,
pages = [
"Home" => "index.md"
"Manual" => [
Expand Down

0 comments on commit 159c441

Please sign in to comment.