docs: try to adjust to modified docs project by developing all projects at once #5389
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.
@fingolfin @lgoettgens
I just had a look at the log for the docbuild after #5381 and it looks like this might cause issues once the compat entries of the latest Oscar release and the dev version diverge:
https://github.com/oscar-system/Oscar.jl/actions/runs/18030785975/job/51306551662?pr=5381#step:6:20
The code is trying to activate the docs-project, then adds various dependencies in the exact versions that are currently loaded and will then add Oscar from the current path.
But with the new Oscar entries in the Project.toml this will always try to include a released Oscar version (v1.5.0 in the log above) when the code was supposed to just add the dependencies, this will fail when dev needs different dependencies. (docs build happens with julia 1.10)
I adjusted it to
dev Oscarin the same call which should hopefully avoid this.Note that the default operation of
build_docis to copy theProject.tomlfor the docs to a temporary directory, which makes..useless, but it doesn't matter since the path is fixed by the develop call anyway. The reason for that is that way too often people were having issues building the docs because of an outdated manifest in the docs folder.Alternative
While looking at this I think we could get rid of all the develop stuff (and the Oscar entry in the deps) and maybe avoid some issues with outdated manifests if we use stacked environments.
Basically we could make sure the docs project only has Documenter in it and put something like this at the top of
docs/make.jl:Then this could be run with the Oscar project as active project and doesn't need any extra resolving:
Similarly
build_docwould just need to make sure the project is instantiated and push it to the load path (as it currently does) but we could remove all Oscar related packages from that project.The advantage would be that the Manifest for the docs only contains documenter related packages which are a lot less likely to be outdated and cause resolve errors.