docs: render remaining exported docstrings - #4979
Merged
ChrisRackauckas merged 10 commits intoAug 17, 2026
Merged
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
ChrisRackauckas-Claude
force-pushed
the
agent/render-missing-public-docs
branch
from
August 16, 2026 13:37
f9d4f8f to
964b1a1
Compare
This was referenced Aug 16, 2026
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Member
Author
|
Pushed Verification on the pushed tree:
The standalone docs build was started but stopped after Documenter reported |
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
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 it has been reviewed by @ChrisRackauckas.
What changed
This gives every exported docstring reported by strict Documenter a canonical rendered location:
ModelingToolkitBasebindings;isinitial, homotopy diagnostics, and the StateSelection matrix helpers are rendered in their relevant manual sections;The four dynamic-problem entries formerly canonicalized on the general problems page moved to the dedicated dynamic-optimization page. Their public documentation remains rendered exactly once.
Failing before
The clean-master strict docs build reported:
A formal bisect of the strict missing-docs gate identified 92c27bb as the first commit that enabled fatal
checkdocs = :exportswithout warning-only handling.Passing after
On exact upstream
f3248317cb51e08e78fb3d1729286905ad61d6d4, I ran:DISPLAY=:0 JULIA_DEBUG=Documenter xvfb-run -a -s '-screen 0 1024x768x24' \ julia +lts --startup-file=no --project=docs/ --code-coverage=user docs/make.jlDocumenter emitted no
docstrings not included in the manualdiagnostic, and:missing_docsdisappeared from the terminal error set:The remaining failures are independent clean-master clusters. The duplicate clusters are isolated in #4977 and #4978. Four invalid
StateSelectionentries and unresolved links remain under separate investigation. Link checking encountered transient remote failures.Other local verification
These pass. The Julia invocation is used because an unrelated executable named
runicshadows Runic.jl on this host.GROUP=QA julia +lts --startup-file=no --project -e 'using Pkg; Pkg.test()'completed with38 pass, 4 error. The four errors are the independently reproduced clean-master ExplicitImports checks:no_implicit_imports,no_stale_explicit_imports,all_explicit_imports_via_owners, andall_qualified_accesses_via_owners.I did not run GPU, downstream, or
GROUP=Everythingjobs.Links