From 5e9240ae63e5d4217e1dc17cc14deca1d74c1ad7 Mon Sep 17 00:00:00 2001 From: Yuto Horikawa Date: Tue, 9 Jan 2024 20:59:02 +0900 Subject: [PATCH] Update for Documenter.jl v1 (#683) * ignore `docs/Manifest.toml` * add missing docstrings * add compat table for Documneter.jl * rename Other API with Internal API * Use `checkdocs=:exports` and ignore internal docstrings as strongly suggested by the reviewer --- .gitignore | 1 + docs/Project.toml | 3 +++ docs/make.jl | 3 ++- 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 78fb62c9..69feffb1 100644 --- a/.gitignore +++ b/.gitignore @@ -4,5 +4,6 @@ *.DS_Store /docs/build/ /docs/site/ +/docs/Manifest.toml /benchmark_data/ /Manifest.toml diff --git a/docs/Project.toml b/docs/Project.toml index 050425cf..9b9a6718 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,3 +1,6 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210" + +[compat] +Documenter = "1" diff --git a/docs/make.jl b/docs/make.jl index e653afca..4bbc19af 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -11,7 +11,8 @@ makedocs(modules=[ForwardDiff], "Upgrading from Older Versions" => "user/upgrade.md"], "Developer Documentation" => [ "How ForwardDiff Works" => "dev/how_it_works.md", - "How to Contribute" => "dev/contributing.md"]]) + "How to Contribute" => "dev/contributing.md"]], + checkdocs=:exports) deploydocs( repo = "github.com/JuliaDiff/ForwardDiff.jl.git"