Skip to content

ci: add Documentation workflow and docs sources - #232

Draft
ChrisRackauckas-Claude wants to merge 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:docs/add-docs-ci
Draft

ChrisRackauckas-Claude wants to merge 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:docs/add-docs-ci

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member

Please ignore until reviewed by @ChrisRackauckas.

What changed and why

This repo had no documentation CI and no docs sources at all, so none of the premade prob_* problems were documented anywhere. Adds:

docs/Project.toml pins the seven sublibraries (all registered), the umbrella package and Documenter; the umbrella package itself is Pkg.developed by path by CI as usual. docs/build/ is now gitignored.

Verification (local, Julia 1.12.4)

After Pkg.develop(PackageSpec(path=pwd())) + Pkg.instantiate() exactly as CI performs:

[ Info: Populate: populating indices.
[ Info: RenderDocument: rendering document.
[ Info: HTMLWriter: rendering HTML pages.
│     HTML file:           api.html
[ Info: Automatic `version="5.3.0"` for inventory from ../Project.toml

grep -cE "failed to run|ERROR" → 0. The home page has one executing @example problem-library block (solve(prob_ode_linear, Tsit5()) printing its retcode); it executed as part of this build, so no example is left unexecuted.

Not verified

  • CI docs run on this PR (pending). Deployed rendering follows automatically once master docs complete.
  • The larger API page renders every docstring in the seven sublibraries; I verified it renders and the build completes, but did not eyeball each rendered entry.

🤖 Generated with OpenCode (model: muse-spark-1.3-contributor-free); no public session URL (local session at /home/crackauc/sandbox/tmp_20260917_040834_91074).

This repo had no documentation CI and no docs sources. Adds a docs tree that
documents the umbrella package, the seven problem sublibraries and their
premade `prob_*` constructors, plus the standard reusable Documentation
workflow including the token permissions the reusable requires (cf.
SciML/DataCollocations.jl#54).

Verified with a full local docs build: zero failed blocks, and the executable
example on the home page (`solve(prob_ode_linear, Tsit5())`) runs as part of
the build.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Agent-Harness: OpenCode
Agent-Model: muse-spark-1.3-contributor-free
Agent-Session: local session at /home/crackauc/sandbox/tmp_20260917_040834_91074 (no public conversation URL)
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.

2 participants