ci: add Documentation workflow and build the existing docs sources - #71
Merged
ChrisRackauckas merged 1 commit intoSep 19, 2026
Merged
Conversation
The repo already had `docs/src/api.md` but no `docs/make.jl`, no docs environment and no workflow, so the API reference was never built or rendered. Adds the missing docs environment, a home page that renders the package docstring and usage, and the standard reusable Documentation workflow including the token permissions the reusable requires (cf. SciML/DataCollocations.jl#54). Each public name is rendered exactly once: the module docstring on the home page and the exported helpers on the API page, so Documenter's duplicate-docs check passes. Verified with a full local docs build (zero errors). 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)
ChrisRackauckas
marked this pull request as ready for review
September 19, 2026 20:28
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
The repo already shipped
docs/src/api.mdbut had nodocs/make.jl, no docs environment, and no workflow, so the API reference was never built or rendered anywhere. Adds the missing docs environment (docs/Project.toml,docs/make.jl), a home page that renders the package docstring and a short usage section, and the standard reusable Documentation workflow including the token permissions the reusable requires (cf. SciML/DataCollocations.jl#54).Each public name is rendered exactly once — the module docstring on the home page, the exported helpers on the API page — so Documenter's duplicate-docs check passes rather than reporting every export twice.
Verification (local, Julia 1.12.4)
After
Pkg.develop(PackageSpec(path=pwd()))+Pkg.instantiate()exactly as CI performs:Zero errors. The page contains no
@exampleblocks (it is a reference page for a test harness), so there is no unexecuted example; every documented name is rendered.Not verified
maindocs 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).