From 94a6dc478aaf3228d0264d0d10580c36fe558510 Mon Sep 17 00:00:00 2001 From: Alex Arslan Date: Wed, 4 Oct 2023 09:04:46 -0700 Subject: [PATCH] Fix documentation deployment 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`. --- .gitignore | 5 +++++ docs/Project.toml | 3 +++ docs/make.jl | 2 +- 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 90debbd..d780a3d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,8 @@ benchmarks/graphs/* *~ *.kate-swp +*.jl.cov +*.jl.*.cov +*.jl.mem +/docs/build/ +Manifest.toml diff --git a/docs/Project.toml b/docs/Project.toml index b097eb4..2685ca8 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,3 +1,6 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" LsqFit = "2fda8390-95c7-5789-9bda-21331edee243" + +[compat] +Documenter = "1" diff --git a/docs/make.jl b/docs/make.jl index a475e84..c4adec9 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -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",