From 952a424308f6f189489bc0de7dd1fcc73d2ce061 Mon Sep 17 00:00:00 2001 From: ChrisRackauckas-Claude Date: Thu, 16 Jul 2026 17:48:59 -0400 Subject: [PATCH] Enable rendered API docs QA in ODEInterfaceDiffEq Co-Authored-By: Chris Rackauckas --- docs/.gitignore | 1 + docs/Project.toml | 6 ++++++ docs/make.jl | 20 ++++++++++++++++++++ docs/src/index.md | 14 ++++++++++++++ test/qa/qa.jl | 9 +++++++++ 5 files changed, 50 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/Project.toml create mode 100644 docs/make.jl create mode 100644 docs/src/index.md diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..16616de --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,6 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +ODEInterfaceDiffEq = "09606e27-ecf5-54fc-bb29-004bd9f985bf" + +[compat] +Documenter = "1" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..88c163b --- /dev/null +++ b/docs/make.jl @@ -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", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..b10015e --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,14 @@ +# ODEInterfaceDiffEq.jl + +```@docs +ODEInterfaceAlgorithm +dopri5 +dop853 +odex +seulex +radau +radau5 +rodas +ddeabm +ddebdf +``` diff --git a/test/qa/qa.jl b/test/qa/qa.jl index 23eb4ec..0a9dc71 100644 --- a/test/qa/qa.jl +++ b/test/qa/qa.jl @@ -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),