Skip to content

Comments

Extend API section with additional solver libraries#839

Merged
ChrisRackauckas merged 4 commits intoSciML:masterfrom
ChrisRackauckas-Claude:extend-api-documentation
Jan 21, 2026
Merged

Extend API section with additional solver libraries#839
ChrisRackauckas merged 4 commits intoSciML:masterfrom
ChrisRackauckas-Claude:extend-api-documentation

Conversation

@ChrisRackauckas-Claude
Copy link
Contributor

Summary

  • Adds API documentation pages for more solver libraries beyond OrdinaryDiffEq and Sundials
  • Reorganizes the API section into "Native Julia Solvers" and "External Wrappers" subsections

New API Documentation Pages

Native Julia Solvers:

  • DelayDiffEq.jl - DDE solvers (MethodOfSteps)
  • SteadyStateDiffEq.jl - Steady state solvers (DynamicSS, SSRootfind)
  • BoundaryValueDiffEq.jl - BVP solvers (Shooting, MultipleShooting, MIRK, FIRK, Ascher methods)
  • DiffEqCallbacks.jl - Callback library (ManifoldProjection, SavingCallback, TerminateSteadyState, etc.)
  • SimpleDiffEq.jl - Simplified solvers (SimpleTsit5, GPUVern7, GPUVern9, etc.)
  • DASSL.jl - Native Julia DAE solver

External Wrappers:

  • LSODA.jl - Stiff/non-stiff auto-switching algorithm
  • ODEInterfaceDiffEq.jl - Fortran solver wrappers (dopri5, dop853, radau, seulex, BVPM2, BVPSOL, COLNEW)

Files Changed

  • docs/pages.jl - Reorganized API section structure
  • docs/make.jl - Added imports and modules for new packages
  • docs/Project.toml - Added package dependencies and compat entries
  • 8 new API documentation files in docs/src/api/

Test plan

  • Documentation builds successfully
  • All new API pages render correctly with docstrings
  • Navigation structure is correct in the sidebar

🤖 Generated with Claude Code

claude and others added 4 commits January 21, 2026 05:28
Add API documentation pages for more solver libraries beyond OrdinaryDiffEq
and Sundials:

Native Julia Solvers:
- DelayDiffEq.jl (DDE solvers)
- SteadyStateDiffEq.jl (steady state solvers)
- BoundaryValueDiffEq.jl (BVP solvers)
- DiffEqCallbacks.jl (callback library)
- SimpleDiffEq.jl (simplified solvers)
- DASSL.jl (native Julia DAE solver)

External Wrappers:
- LSODA.jl (stiff/non-stiff switching)
- ODEInterfaceDiffEq.jl (Fortran solver wrappers)

Also reorganizes the API section into "Native Julia Solvers" and
"External Wrappers" subsections for better organization.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The SimpleDiffEq and DASSL packages don't have docstrings for their
exported algorithms, so using @docs blocks causes the docs build to
fail. Replace with plain markdown descriptions instead.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
SimpleDiffEq and DASSL don't have docstrings, so Documenter's auto-linking
of backticked code to cross-references fails. Using double backticks
prevents auto-linking while still rendering as code.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@ChrisRackauckas ChrisRackauckas merged commit f492b1d into SciML:master Jan 21, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants