Skip to content

Enable rendered public API docs QA - #253

Merged
ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:agent/public-api-rendered-docs-qa
Jul 20, 2026
Merged

ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:agent/public-api-rendered-docs-qa

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member

Ignore this PR until reviewed by @ChrisRackauckas.

Summary

  • Enable SciMLTesting rendered public API docs QA via api_docs_kwargs = (; rendered = true).
  • Keep the change scoped to the QA invocation; exported package-owned API docstrings and rendered @docs entries were already present.
  • Do not add [sources] or path source entries to tracked project files.

Validation

  • git diff --check
  • julia +1.10 via juliaup shim, Runic.jl formatter check on test/qa/qa.jl
  • julia +1.10 --project=docs docs/make.jl
  • julia +1.10 --project=test/qa test/qa/qa.jl (16 pass, 1 expected broken)
  • julia +1.10 --project=. -e 'using Pkg; Pkg.test(; test_args = ["QA"])' passed, but the harness ran Core tests rather than only QA\n

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas-Claude
ChrisRackauckas-Claude marked this pull request as ready for review July 17, 2026 04:28
@ChrisRackauckas
ChrisRackauckas merged commit 852749d into SciML:master Jul 20, 2026
16 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.

2 participants