From 305059976b20c6b69554034b0fbdeaea95385d4e Mon Sep 17 00:00:00 2001 From: hyrodium Date: Fri, 5 Jan 2024 01:54:35 +0900 Subject: [PATCH 1/5] ignore `docs/Manifest.toml` --- .gitignore | 1 + 1 file changed, 1 insertion(+) 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 From 6e77ab9214a4fb041f3cee27153a3e00081836f5 Mon Sep 17 00:00:00 2001 From: hyrodium Date: Fri, 5 Jan 2024 01:54:48 +0900 Subject: [PATCH 2/5] add missing docstrings --- docs/src/user/api.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/src/user/api.md b/docs/src/user/api.md index 25289ed7..df8d7fd1 100644 --- a/docs/src/user/api.md +++ b/docs/src/user/api.md @@ -60,3 +60,9 @@ ForwardDiff.GradientConfig ForwardDiff.JacobianConfig ForwardDiff.HessianConfig ``` + +## Other API +```@docs +ForwardDiff.can_dual +ForwardDiff.:≺ +``` From e4de4adbc0627722639e1cf36aa84dc44a4fd38b Mon Sep 17 00:00:00 2001 From: hyrodium Date: Fri, 5 Jan 2024 12:12:45 +0900 Subject: [PATCH 3/5] add compat table for Documneter.jl --- docs/Project.toml | 3 +++ 1 file changed, 3 insertions(+) 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" From da73a0f8ce4654a6308bebe2d83269f6a2b47db8 Mon Sep 17 00:00:00 2001 From: hyrodium Date: Fri, 5 Jan 2024 21:53:26 +0900 Subject: [PATCH 4/5] rename Other API with Internal API --- docs/src/user/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/user/api.md b/docs/src/user/api.md index df8d7fd1..e54a59b8 100644 --- a/docs/src/user/api.md +++ b/docs/src/user/api.md @@ -61,7 +61,7 @@ ForwardDiff.JacobianConfig ForwardDiff.HessianConfig ``` -## Other API +## Internal API ```@docs ForwardDiff.can_dual ForwardDiff.:≺ From 675b1911e192136e77100c56d06d019d73481fc5 Mon Sep 17 00:00:00 2001 From: hyrodium Date: Sat, 6 Jan 2024 12:42:36 +0900 Subject: [PATCH 5/5] Use `checkdocs=:exports` and ignore internal docstrings as strongly suggested by the reviewer --- docs/make.jl | 3 ++- docs/src/user/api.md | 6 ------ 2 files changed, 2 insertions(+), 7 deletions(-) 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" diff --git a/docs/src/user/api.md b/docs/src/user/api.md index e54a59b8..25289ed7 100644 --- a/docs/src/user/api.md +++ b/docs/src/user/api.md @@ -60,9 +60,3 @@ ForwardDiff.GradientConfig ForwardDiff.JacobianConfig ForwardDiff.HessianConfig ``` - -## Internal API -```@docs -ForwardDiff.can_dual -ForwardDiff.:≺ -```