Skip to content

Enable rendered public API docs QA#639

Draft
ChrisRackauckas-Claude wants to merge 5 commits into
SciML:masterfrom
ChrisRackauckas-Claude:agent/datadrivendiffeq-scimltesting-v21-compat
Draft

Enable rendered public API docs QA#639
ChrisRackauckas-Claude wants to merge 5 commits into
SciML:masterfrom
ChrisRackauckas-Claude:agent/datadrivendiffeq-scimltesting-v21-compat

Conversation

@ChrisRackauckas-Claude

@ChrisRackauckas-Claude ChrisRackauckas-Claude commented Jul 15, 2026

Copy link
Copy Markdown
Member

Ignore until reviewed by @ChrisRackauckas.

Summary

  • enable SciMLTesting v2.1+ rendered public API docs QA for the root package and subpackages with api_docs_kwargs = (; rendered = true, ...)
  • ignore dependency-owned reexports in docs QA instead of documenting dependency-owned names locally
  • render package-owned public APIs in the manual, remove local reexport-doc shims, and fix stale DataDrivenLux source-doc links
  • keep Julia 1.10 nested QA local-package resolution in runtests.jl without adding new [sources] or path source entries

Local verification

All Julia commands used /home/crackauc/.juliaup/bin/julia +1.10 and timeout 3600. Most Julia commands used JULIA_DEPOT_PATH=/home/crackauc/sandbox/tmp_20260708_051717_3275/julia_depots/datadrivendiffeq_scimltesting_v21; Runic used /home/crackauc/sandbox/tmp_20260708_051717_3275/.julia_depot_runic.

  • git diff --check: passed with no output
  • Runic over changed .jl files: passed with no output
  • worktree-inclusive Project diff scan for newly added [sources] / path =: passed with no output
  • docs build, julia +1.10 --project=docs docs/make.jl: passed. Remaining warnings were Documenter warnonly warnings for existing unrendered StatsAPI method docstrings / module docstring, linkcheck redirects, large @example HTML fallback, and skipped deployment auto-detection.
  • root QA, GROUP=QA julia +1.10 --project=. -e 'using Pkg; Pkg.test(; coverage=false)': passed. Quality Assurance | 13 pass, 4 broken, 17 total; JET Static Analysis | 10 pass, 1 broken, 11 total.
  • DMD QA, GROUP=DataDrivenDMD_QA julia +1.10 --project=. -e 'using Pkg; Pkg.test(; coverage=false)': passed. QA | 16 pass, 2 broken, 18 total.
  • Sparse QA from lib/DataDrivenSparse, GROUP=QA julia +1.10 --project=. -e 'using Pkg; Pkg.test(; coverage=false)': passed. QA | 16 pass, 2 broken, 18 total.
  • Lux QA from lib/DataDrivenLux, GROUP=QA julia +1.10 --project=. -e 'using Pkg; Pkg.test(; coverage=false)': passed after the final docstring-link fix. QA | 17 pass, 1 broken, 18 total.
  • SR QA from lib/DataDrivenSR, GROUP=QA julia +1.10 --project=. -e 'using Pkg; Pkg.test(; coverage=false)': passed. Quality Assurance | 17 pass, 1 broken, 18 total.

Not run: full all-groups root Pkg.test(). This was kept scoped to docs/docstrings/rendered QA plus the affected QA groups.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas

Copy link
Copy Markdown
Member

Don't reexport symbolicregression

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas-Claude ChrisRackauckas-Claude changed the title Allow SciMLTesting v2.1 in QA Enable rendered public API docs QA Jul 17, 2026
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member Author

Follow-up after CI caught DataDrivenSR core tests relying on the old SymbolicRegression reexport.

Fix pushed: 59b54000

What changed:

  • lib/DataDrivenSR/test/Core/symbolic_regression.jl now imports SymbolicRegression and calls SymbolicRegression.Options(...) explicitly.
  • Removed the now-unused Reexport dependency/compat entry from lib/DataDrivenSR/Project.toml; DataDrivenSR no longer uses @reexport.

Local validation on Julia 1.10:

  • git diff --check: passed.
  • Runic --check on lib/DataDrivenSR/test/Core/symbolic_regression.jl and lib/DataDrivenSR/Project.toml: passed.
  • GROUP=DataDrivenSR Pkg.test(; coverage=false): passed, Symbolic Regression | 6 pass.
  • GROUP=DataDrivenSR_QA Pkg.test(; coverage=false): passed, Quality Assurance | 17 pass, 1 broken, 18 total.

Generated lib/DataDrivenSR/test/outputs/ files from the local SymbolicRegression run were removed before commit.

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