Fix docs build: add git [sources] for unregistered QuadDIRECT#1232
Conversation
The Documentation workflow fails at the very first instantiate step
(`Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()`) with:
ERROR: expected package `QuadDIRECT [dae52e8d]` to be registered
`docs/Project.toml` lists `QuadDIRECT` (and `OptimizationQuadDIRECT`,
which depends on it) in `[deps]`, but `QuadDIRECT` is not registered in
General and had no `[sources]` entry, so the docs environment could not
resolve. Add a git `[sources]` entry pointing at the upstream repo, the
same source the docs page already instructs users to add manually.
Verified locally on Julia 1.12 (the docs CI channel): the docs
environment now resolves and instantiates; QuadDIRECT is pulled from
https://github.com/timholy/QuadDIRECT.jl.git and OptimizationQuadDIRECT
resolves against it.
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The QuadDIRECT [sources] fix got the docs build past instantiate, which
then surfaced pre-existing makedocs errors [:example_block, :linkcheck].
- lib/SimpleOptimization: SimpleBFGS/SimpleLBFGS passed the obsolete
`linesearch = Val(false)` to SimpleBroyden/SimpleLimitedMemoryBroyden.
SimpleNonlinearSolve v2.x's `linesearch` keyword is
`Union{Nothing, LineSearch.AbstractLineSearchAlgorithm}` and rejects
`Val{false}` with a TypeError; `nothing` is the documented "no line
search" value. This also fixes the sublibrary's own (red) Core tests.
- evolutionary.md: Evolutionary.jl moved wildart -> SciML; the four
wildart.github.io/Evolutionary.jl/stable/{ga,de,es,cmaes}/ links 404.
Repoint to sciml.github.io and the repo links to github.com/SciML.
- nlopt.md: http://ab-initio.mit.edu/nlopt/ is dead (linkcheck timeout);
repoint the NLopt library link to https://nlopt.readthedocs.io/en/latest/.
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Docs build: root-cause analysis + additional fixes pushedThe QuadDIRECT That exposed pre-existing Fixed in commit 22b43d2 (pushed to this branch)
Remaining blocker — NOT fixable in this repo (upstream SciMLBase)
So this PR makes all of Optimization.jl's own docs problems pass; the last red is a SciMLBase upstream docstring link. Please ignore until reviewed by @ChrisRackauckas. |
The `OptimizationProblem` docstring linked to `docs.sciml.ai/Optimization/dev/optimization_packages/optimization`, which does not exist (returns a non-200 / 403). Repoint it to the Sophia package page at `optimization_packages/sophia/`, which is the actual page hosting the `Sophia` data-handling example referenced in the text. Because Optimization.jl renders SciMLBase docstrings (`modules=[..., SciMLBase, ...]`), this dead link is the remaining `:linkcheck` failure in SciML/Optimization.jl#1232. Co-authored-by: ChrisRackauckas-Claude <accounts@chrisrackauckas.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Problem
The
Documentation / Build and Deploy Documentationcheck onmasterfails at the first instantiate step:docs/Project.tomllists bothQuadDIRECTandOptimizationQuadDIRECT(which depends onQuadDIRECT) in[deps].QuadDIRECTis not registered in the General registry and had no[sources]entry, so the docs environment cannot resolve. This reproduces on every recent docs run onmasterand PRs.Fix
Add a git
[sources]entry forQuadDIRECTpointing at the upstream repository — the same source the QuadDIRECT docs page already instructs users to install manually (] add https://github.com/timholy/QuadDIRECT.jl.git):Local verification
Ran the exact docs CI command on Julia 1.12 (the docs CI channel):
Previously this errored at resolution. With the fix, the docs environment resolves and instantiates. The resolved
docs/Manifest.tomlpullsQuadDIRECTfrom the git URL andOptimizationQuadDIRECTresolves against it:Scope note
This PR fixes only the docs-build resolution failure. The other current
masterreds are tracked separately:OptimizationCMAEvolutionStrategy [QA] / Julia lts— already fixed by theSciML/.github@v1develop_sources.jlupdate (which now skips a dependency's test-only[sources]); that fix landed ~50 min after the stale CI run on master, so this just needs a fresh CI run. Verified locally that the QA group passes 12/12 on Julia 1.10 with the current@v1script.Downgrade/downgrade-sublibraries— the known--min=@alldepscompat-floor conflict on Julia 1.10 (open-ended floors likeComponentArrays >= 0.13.9); a separate, fleet-wide effort.ModelingToolkit.jl/All,NeuralPDE.jl/NNPDEdownstream — out of scope.Please ignore until reviewed by @ChrisRackauckas