Skip to content

Commit

Permalink
Update for Documenter.jl v1 (#683)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
hyrodium authored Jan 9, 2024
1 parent d300209 commit 5e9240a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
*.DS_Store
/docs/build/
/docs/site/
/docs/Manifest.toml
/benchmark_data/
/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"
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"

[compat]
Documenter = "1"
3 changes: 2 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 5e9240a

Please sign in to comment.