Enable rendered public API docs QA - #1090
ChrisRackauckas merged 2 commits into
Conversation
|
Current failing The failing ExplicitImports check is for the existing qualified access: It is used in I did not add an ignore here because the better fix is to make the owner package declare and document the API that NonlinearSolveBase already depends on. Once that PR is merged/released, this QA failure should be resolvable without documenting dependency-owned API in NonlinearSolve. |
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
599e1b8 to
66f4302
Compare
|
Rebased this draft onto current Local validation on Julia 1.12.6:
This confirms #1090 is the existing focused fix for the SciMLTesting 2.3 rendered-public-API failure on current master. The separate SciMLTesting 2.4 unapproved-reexport regression remains tracked upstream in SciML/SciMLTesting.jl#29 and is not folded into this PR. Please continue to ignore this draft until reviewed by @ChrisRackauckas. |
|
CI follow-up after rebasing onto exact current master
No #1090-specific regression was found, so I have not changed or weakened its QA assertions. |
Ignore until reviewed by @ChrisRackauckas.
Summary
rendered_ignoreonly for external reexports.SCCNonlinearSolveto the docs build module list and rendered docs index without adding any[sources]or path source entries.Validation
git diff --checkpassed with no output.timeout 3600 julia -e 'using Runic; exit(Runic.main(["--check", "docs/make.jl", "test/qa/qa.jl", "lib/BracketingNonlinearSolve/test/qa/qa.jl", "lib/NonlinearSolveBase/test/qa/qa.jl", "lib/NonlinearSolveFirstOrder/test/qa/qa.jl", "lib/NonlinearSolveHomotopyContinuation/test/qa/qa.jl", "lib/NonlinearSolveQuasiNewton/test/qa/qa.jl", "lib/NonlinearSolveSciPy/test/qa/qa.jl", "lib/NonlinearSolveSpectralMethods/test/qa/qa.jl", "lib/SCCNonlinearSolve/test/qa/qa.jl", "lib/SciMLJacobianOperators/test/qa/qa.jl", "lib/SimpleNonlinearSolve/test/qa/qa.jl"]))'Quality Assurance | 13 pass 13 total 59.2s.Public API documentation | 2 pass 2 total 3.7s) but the full QA still fails on an unrelated pre-existing ExplicitImports issue:SingleCacheStorageis imported fromFunctionWrappersWrappersbut is not public.test/qaenvironment on Julia +1.10 failed before tests during precompilation (UndefVarError: StaticData not definedwhile precompiling PrecompileTools/ExplicitImports/SciMLTesting), so direct +1.10 rendered QA was run in a fresh temporary local environment instead.timeout 3600 julia --project=docs -e 'using Pkg; Pkg.update(); Pkg.instantiate(); include("docs/make.jl")'; it reacheddocs/make.jland failed on the existing duplicate BibTeX keyyuan2015recent, covered separately by PR Remove duplicate BibTeX entry #1088.