Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
build/
6 changes: 6 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
ODEInterfaceDiffEq = "09606e27-ecf5-54fc-bb29-004bd9f985bf"

[compat]
Documenter = "1"
20 changes: 20 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
using Documenter
using ODEInterfaceDiffEq

makedocs(;
modules = [ODEInterfaceDiffEq],
sitename = "ODEInterfaceDiffEq.jl",
format = Documenter.HTML(;
prettyurls = get(ENV, "CI", "false") == "true",
canonical = "https://docs.sciml.ai/ODEInterfaceDiffEq/stable/",
edit_link = "master",
),
pages = [
"Home" => "index.md",
],
)

deploydocs(;
repo = "github.com/SciML/ODEInterfaceDiffEq.jl",
devbranch = "master",
)
14 changes: 14 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# ODEInterfaceDiffEq.jl

```@docs
ODEInterfaceAlgorithm
dopri5
dop853
odex
seulex
radau
radau5
rodas
ddeabm
ddebdf
```
9 changes: 9 additions & 0 deletions test/qa/qa.jl
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,17 @@ const QUALIFIED_ARE_PUBLIC_IGNORE = (
:rodas, :seulex, :solution_new_retcode,
)

const API_DOCS_RENDERED_IGNORE = (
Tuple(names(ODEInterfaceDiffEq.DiffEqBase))...,
:OverrideInit, :NoInit, :CheckInit, :DefaultInit,
)

run_qa(
ODEInterfaceDiffEq;
api_docs_kwargs = (;
rendered = true,
rendered_ignore = API_DOCS_RENDERED_IGNORE,
),
explicit_imports = true,
ei_kwargs = (;
all_qualified_accesses_via_owners = (; ignore = QUALIFIED_VIA_OWNERS_IGNORE),
Expand Down
Loading