Skip to content

Fix documentation examples for current dependency APIs#4746

Merged
ChrisRackauckas merged 2 commits into
SciML:masterfrom
ChrisRackauckas-Claude:agent/fix-docs-example-regressions
Jul 13, 2026
Merged

Fix documentation examples for current dependency APIs#4746
ChrisRackauckas merged 2 commits into
SciML:masterfrom
ChrisRackauckas-Claude:agent/fix-docs-example-regressions

Conversation

@ChrisRackauckas-Claude

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

Copy link
Copy Markdown
Member

This PR should be ignored until reviewed by @ChrisRackauckas.

Dependency

This PR is stacked on #4745, which fixes the pre-existing spell-check typo on master. Review and merge #4745 first; the documentation fix remains a separate commit on top.

Summary

  • Add direct documentation dependencies for Graphs, OrdinaryDiffEqFunctionMap, and OrdinaryDiffEqRosenbrock.
  • Replace the removed accidental BipartiteGraphs incidence_matrix re-export and internal tearing-state access with documented public APIs from Graphs.LinAlg and ModelingToolkitBase.
  • Update BifurcationKit and OrdinaryDiffEq examples to their current public owner APIs.

Regression attribution

  • BipartiteGraphs commit 6f9fbf5701e4 stopped accidentally exposing Graphs.incidence_matrix after switching to explicit imports.
  • BifurcationKit 0.8 removed the old PeriodicOrbitOCollProblem compatibility name in favor of Collocation.
  • OrdinaryDiffEq 7 reduced its umbrella exports, so FunctionMap and Rodas4 must be imported from their owning sublibraries.

Verification

  • Exact discrete-system tutorial example: exit 0; retcode=Success, points=101, final_t=100.0.
  • Public-API smoke covering incidence_matrix/asgraph, a Rodas4 solve, and Collocation construction: exit 0; incidence=Bool[1;;], retcode=Success, collocation=(0, 5, 20).
  • Full Julia LTS CI-style documentation build from a fresh normal HTTPS clone detached at the documentation commit before stacking (90a21a1d7c86dbc042eec75e3b5af89b08ac0911): exit 0. All examples, link checks, and HTML rendering completed successfully.
  • Typos CLI 1.48.0 on the stacked tree: exit 0.
  • Runic 1.7.0 over every tracked Julia file on the stacked tree: exit 0.
  • git diff --check upstream/master...HEAD: exit 0.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas-Claude
ChrisRackauckas-Claude force-pushed the agent/fix-docs-example-regressions branch from 90a21a1 to 742e993 Compare July 13, 2026 19:02
@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member Author

Post-stack verification is complete.

CI=true GITHUB_ACTIONS=true GITHUB_EVENT_NAME=push \
GITHUB_REF=refs/heads/agent/fix-docs-example-regressions \
GITHUB_REF_NAME=agent/fix-docs-example-regressions GITHUB_REF_TYPE=branch \
GITHUB_REPOSITORY=SciML/ModelingToolkit.jl GITHUB_REPOSITORY_OWNER=SciML \
GITHUB_SHA=90a21a1d7c86dbc042eec75e3b5af89b08ac0911 \
GITHUB_WORKSPACE=/home/crackauc/sandbox/tmp_20260713_111059_49183/_verification/modelingtoolkit-pr4746 \
GITHUB_SERVER_URL=https://github.com JULIA_DEBUG=Documenter \
JULIA_DEPOT_PATH=/home/crackauc/sandbox/tmp_20260713_111059_49183/_verification/depot-pr4746 \
TMPDIR=/home/crackauc/sandbox/tmp_20260713_111059_49183/_verification/tmp-pr4746 \
DISPLAY=:0 xvfb-run -a -s '-screen 0 1024x768x24' \
/home/crackauc/.juliaup/bin/julia +lts --startup-file=no --project=docs/ --code-coverage=user docs/make.jl

It exited 0 after completing all examples, link checks, and HTML rendering. In particular, the repaired tearing/Graphs, BifurcationKit Collocation, discrete FunctionMap, and Rodas4 examples all evaluated successfully.

On the final stacked tree:

  • /home/crackauc/sandbox/tmp_20260713_111059_49183/_tools/typos-1.48.0/typos --version reported typos-cli 1.48.0; running that binary at the repository root exited 0.
  • Runic 1.7.0 with --check over every path from git ls-files -z '*.jl' exited 0.
  • git diff --check upstream/master...HEAD exited 0.

@ChrisRackauckas-Claude

ChrisRackauckas-Claude commented Jul 13, 2026

Copy link
Copy Markdown
Member Author

Current red-check classification after independent clean-base reproduction:

These are independent of the documentation-example repairs here. The fresh-clone CI-style docs build for this exact patch already exited 0, including examples, rendering, and link checks.

@ChrisRackauckas
ChrisRackauckas marked this pull request as ready for review July 13, 2026 19:59
@ChrisRackauckas
ChrisRackauckas merged commit db56a6a into SciML:master Jul 13, 2026
59 of 67 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