Add StochasticDiffEq docs to lib/StochasticDiffEq/docs#3759
Merged
ChrisRackauckas merged 1 commit intoJun 16, 2026
Merged
Conversation
When StochasticDiffEq moved into this monorepo for v7, its `docs/` were left behind in the now-frozen standalone SciML/StochasticDiffEq.jl repo (last tagged v6.100.0). As a result `lib/StochasticDiffEq` ships no `docs/`, so DiffEqDocs.jl — which aggregates each solver package's `docs/src` + `pages.jl` via `pathof(StochasticDiffEq)/../docs` — can no longer find them, and the "StochasticDiffEq.jl API" section silently dropped out of the unified docs. This migrates those docs (src/ + pages.jl) into `lib/StochasticDiffEq/docs`, plus a make.jl/Project.toml mirroring the root docs setup so they build standalone. Once a StochasticDiffEq release ships this `docs/` in its registered tarball, DiffEqDocs picks the API reference back up with no `Pkg.develop` needed. The docstrings are now spread across the StochasticDiffEq* subpackages (v7 split), so make.jl lists them in `modules`; StochasticDiffEq @reexports them. Verified locally (StochasticDiffEq 7.0.0 + subpackages, Documenter): all 71 `@docs`-referenced solvers (EM, SRIW1, SOSRI, ImplicitEM, …) resolve with docstrings, and `makedocs` builds every page (index, usage, nonstiff/*, stiff/*, jumpdiffusion, misc) with no docs-block errors. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
Please ignore until reviewed by @ChrisRackauckas. Opened as a draft.
When StochasticDiffEq moved into this monorepo for v7, its
docs/were left behind in the now-frozen standaloneSciML/StochasticDiffEq.jlrepo (last tagged v6.100.0). Solib/StochasticDiffEqships nodocs/, and DiffEqDocs.jl — which aggregates each solver package'sdocs/src+pages.jlviapathof(StochasticDiffEq)/../docs— can no longer find them. The "StochasticDiffEq.jl API" section silently dropped out of the unified SciML docs.This migrates those docs (
src/+pages.jl) intolib/StochasticDiffEq/docs, plus amake.jl/Project.tomlmirroring the root docs setup so they build standalone. Once a StochasticDiffEq release ships thisdocs/in its registered tarball, DiffEqDocs picks the API reference back up automatically (noPkg.developneeded — see SciML/DiffEqDocs.jl#872).The solver docstrings are now spread across the
StochasticDiffEq*subpackages (the v7 split), somake.jllists them inmodules(StochasticDiffEq@reexports them).Verification (local, StochasticDiffEq 7.0.0 + subpackages, Documenter 1.17)
@docs-referenced solvers (EM, EulerHeun, SRIW1, SOSRI, ImplicitEM, SKenCarp, TauLeaping, …) resolve with docstrings — 0 undefined, 0 missing.makedocsbuilds every page (index, usage, nonstiff/{basic,sra_sri,high_weak,commutative}, stiff/{implicit,split_step,stabilized}, jumpdiffusion/tau_leaping, misc) with no docs-block errors.lib/StochasticDiffEq/docs/Project.toml(with[sources]→lib/) resolves cleanly.🤖 Generated with Claude Code