Skip to content

Commit e40919e

Browse files
hyrodiumdevmotion
authored andcommitted
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
1 parent a0e76ad commit e40919e

File tree

3 files changed

+6
-1
lines changed

3 files changed

+6
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
*.DS_Store
55
/docs/build/
66
/docs/site/
7+
/docs/Manifest.toml
78
/benchmark_data/
89
/Manifest.toml

docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
4+
5+
[compat]
6+
Documenter = "1"

docs/make.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ makedocs(modules=[ForwardDiff],
1111
"Upgrading from Older Versions" => "user/upgrade.md"],
1212
"Developer Documentation" => [
1313
"How ForwardDiff Works" => "dev/how_it_works.md",
14-
"How to Contribute" => "dev/contributing.md"]])
14+
"How to Contribute" => "dev/contributing.md"]],
15+
checkdocs=:exports)
1516

1617
deploydocs(
1718
repo = "github.com/JuliaDiff/ForwardDiff.jl.git"

0 commit comments

Comments
 (0)