Skip to content

Commit

Permalink
Fix documentation deployment
Browse files Browse the repository at this point in the history
There was no compatibility set for the Documenter dependency in
`docs/Project.toml`, so a breaking change made in Documenter 1.0 broke
documentation deployment for this package. In particular, the `strict`
keyword argument in `makedocs` was replaced with `warnonly`. To fix it,
we can declare explicit compatibility with Documenter 1.0 and switch to
using `warnonly=true` rather than `strict=false`.

As part of this, I've also added standard entries to `.gitignore`, two
of which are relevant to documentation: the automatically generated
`docs/build/` directory and `Manifest.toml`.
  • Loading branch information
ararslan committed Oct 4, 2023
1 parent 62f3e5f commit 94a6dc4
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
benchmarks/graphs/*
*~
*.kate-swp
*.jl.cov
*.jl.*.cov
*.jl.mem
/docs/build/
Manifest.toml
3 changes: 3 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
LsqFit = "2fda8390-95c7-5789-9bda-21331edee243"

[compat]
Documenter = "1"
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ makedocs(
format = Documenter.HTML(prettyurls = true, canonical="https://julianlsolvers.github.io/LsqFit.jl/stable/"),
sitename = "LsqFit.jl",
doctest = false,
strict = false,
warnonly = true,
pages = Any[
"Home" => "index.md",
"Getting Started" => "getting_started.md",
Expand Down

0 comments on commit 94a6dc4

Please sign in to comment.