ci: add Documentation workflow and docs sources - #232
Draft
ChrisRackauckas-Claude wants to merge 1 commit into
Draft
ChrisRackauckas-Claude wants to merge 1 commit into
ChrisRackauckas-Claude wants to merge 1 commit into
Conversation
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)
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
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.
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/with a home page (what the package is, the seven problem sublibraries, installation, and one runnable example) and an API reference that renders the docstrings of all seven sublibraries.docs/Project.tomlpins the seven sublibraries (all registered), the umbrella package and Documenter; the umbrella package itself isPkg.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:grep -cE "failed to run|ERROR"→ 0. The home page has one executing@example problem-libraryblock (solve(prob_ode_linear, Tsit5())printing itsretcode); it executed as part of this build, so no example is left unexecuted.Not verified
masterdocs complete.🤖 Generated with OpenCode (model: muse-spark-1.3-contributor-free); no public session URL (local session at /home/crackauc/sandbox/tmp_20260917_040834_91074).