Skip to content

Fix docs compatibility with HighDimPDE 2 - #170

Merged
ChrisRackauckas merged 1 commit into
SciML:mainfrom
ChrisRackauckas-Claude:codex/fix-docs-self-compat
Sep 4, 2026
Merged

ChrisRackauckas merged 1 commit into
SciML:mainfrom
ChrisRackauckas-Claude:codex/fix-docs-self-compat

Conversation

@ChrisRackauckas-Claude

@ChrisRackauckas-Claude ChrisRackauckas-Claude commented Sep 4, 2026 •

Copy link
Copy Markdown
Member

Summary

Align the documentation environment's HighDimPDE compatibility with the package's current 2.x major version. The package version was intentionally corrected from 3.0.0 to 2.6.0 in #162, but the docs environment remained constrained to major 3 and can no longer resolve its own package.

Ignore this PR until reviewed by @ChrisRackauckas.

Root cause

git bisect against a direct package-version/docs-compatibility discriminator found a2fe18aced9d97f96e444b1108c6984e1967c60e as the first bad commit:

HighDimPDE 2.6.0 in docs compat 3: false
a2fe18aced9d97f96e444b1108c6984e1967c60e is the first bad commit

The preceding #161 set both the package version and docs compatibility to 3. Pull request #162 correctly restored the package version to 2.6.0 because the QA migration was not breaking, but did not restore the docs self-compatibility.

No separate test file is added: package resolution plus the strict documentation build is the exact discriminating regression test.

Failing before

On clean main at 44fbfc9192d77aad76ee92103a02bd5704647a62:

$ julia +release --project=docs -e 'using Pkg; Pkg.instantiate()'
ERROR: Unsatisfiable requirements detected for package HighDimPDE [57c578d5]:
 HighDimPDE [57c578d5] log:
 ├─possible versions are: 1.2.0 - 2.7.0 or uninstalled
 └─restricted to versions 3 by project [8b9a0876] — no versions left

Passing after

With this one-line compatibility correction:

$ julia +release --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
[57c578d5] + HighDimPDE v2.7.0 `.../HighDimPDE-clean`

$ julia +release --project=docs docs/make.jl
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doctests.
[ Info: ExpandTemplates: expanding markdown templates.
[ Info: CrossReferences: building cross-references.
[ Info: CheckDocument: running document checks.
[ Info: Populate: populating indices.
[ Info: RenderDocument: rendering document.
[ Info: HTMLWriter: rendering HTML pages.
[ Info: Automatic `version="2.7.0"` for inventory from ../Project.toml
┌ Warning: Documenter could not auto-detect the building environment. Skipping deployment.

The build exited successfully with Documenter 1.19.0. It retained the pre-existing nonfatal arXiv 301 redirect warning; deployment was skipped locally as expected.

Verification

$ GROUP=QA julia +release --project=. -e 'using Pkg; Pkg.test()'
Test Summary: | Pass  Total     Time
QA            |   20     20  2m50.6s
Testing HighDimPDE tests passed

$ GROUP=Core julia +release --project=. -e 'using Pkg; Pkg.test()'
ProblemConstructors | 154 / 154
reflect             |   2 /   2
MLP                 |  23 /  23
Deep Splitting      |  19 /  19
DeepBSDE            |   6 /   6
MC Sample           |   7 /   7
NNStopping          |   2 /   2
NNParamKolmogorov   |   1 /   1
Testing HighDimPDE tests passed

$ julia +release --project=.tmp/runic-env -m Runic --check --diff docs
# exit 0

$ typos docs/Project.toml
# exit 0

$ git diff --check
# exit 0

The existing whole-repository Runic failure is intentionally excluded from this docs-only change and is fixed in the separate mechanical PR 171. GPU tests were not run because no GPU is available; this change affects dependency resolution only.

Links

🤖 Generated with Codex CLI 0.151.0 (model: gpt-5.6-sol; session: local session ID 01a0598f-11b9-72d1-91d9-b2fbb186557d).

Align the documentation environment with the package's current major version so the local source can be resolved and built.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: OpenAI Codex <noreply@openai.com>
Agent-Harness: Codex CLI 0.151.0
Agent-Model: gpt-5.6-sol
Agent-Session: local session ID 01a0598f-11b9-72d1-91d9-b2fbb186557d
@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member Author

The hosted Runic failure on this one-line docs-only branch reproduces on unchanged current main and is fixed separately by #171. That companion PR is mechanical-only and its hosted Runic check is green. After PR171 merges, this branch should be rebased so the docs compatibility correction can remain isolated.

@ChrisRackauckas
ChrisRackauckas marked this pull request as ready for review September 4, 2026 21:25
@ChrisRackauckas
ChrisRackauckas merged commit 90a2396 into SciML:main Sep 4, 2026
2 of 3 checks passed
ChrisRackauckas added a commit that referenced this pull request Sep 7, 2026
- compat: drop the unregistered SafeTestsets 1.x major (#168)
- test: use Float32 noise in GPU reflect equivalence test (#169)
- Fix docs compatibility with HighDimPDE 2 (#170)
- Apply current Runic formatting (#171)



Agent-Harness: Claude Code
Agent-Model: claude-opus-5[1m]
Claude-Session: https://claude.ai/code/session_014FEzNTLFutCmTEAZ3zBg5R

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
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