Use rendered public API docs QA - #1272
Merged
ChrisRackauckas merged 2 commits intoJul 21, 2026
Merged
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Member
Author
|
Follow-up pushed: This addresses the two rendered-docs QA failures seen on CI:
Local validation:
The |
ChrisRackauckas
marked this pull request as ready for review
July 21, 2026 15:46
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.
Ignore this PR until reviewed by @ChrisRackauckas.
Summary
api_docs_kwargs = (; rendered = true, ...).rendered_ignoreonly for dependency-owned reexports not rendered in the Optimization docs.OptimizationBasemodule and add its source module docstring.Validation
git diff --checkpassed with no output.Optimization:Public API documentation | 2 pass / 2 total.OptimizationBase:Public API documentation | 2 pass / 2 total.GROUP=QA Pkg.teston Julia 1.10:QA | 17 pass, 1 broken, 18 total;Testing Optimization tests passed.GROUP=OptimizationBase_QA Pkg.teston Julia 1.10:QA | 17 pass, 1 broken, 18 total;Testing OptimizationBase tests passed;Testing Optimization tests passed.GROUP=OptimizationOptimJL_QA Pkg.teston Julia 1.10:Quality Assurance | 17 pass, 1 broken, 18 total;Testing OptimizationOptimJL tests passed;Testing Optimization tests passed.GROUP=OptimizationPRIMA_QA Pkg.teston Julia 1.10:Quality Assurance | 17 pass, 1 broken, 18 total;Testing OptimizationPRIMA tests passed;Testing Optimization tests passed.docs/make.jlon Julia 1.10 passed after local docs env resolution; final output reachedHTMLWriter: rendering HTML pagesand skipped deployment outside CI. Linkcheck emitted existing redirect warnings.