SciML
Create a system for downstream documentation build testing
We have a ton of information in our doc builds. It's where all of our tutorials are! So the biggest stress test is actually the documentation builds. The system of downstream testing by @giordano has been a massive success for our testing, so we would like to get something similarly setup for downstream testing of the documentation. One way I had in mind for doing this was:
- Setup a new test group in
runtests.jlforGROUP=="DownstreamDocs" - Instantiate the docs Project.toml
- Call
include("make.jl) - In the make.jl files, have a
if GROUP!="DownstreamDocs"around the deployment - Add
DownstreamDocsto the Downstream.yml files that need the respective doc tests.
That seems innocent enough, and would work for a lot of cases. Though there are a few cases, like SciMLSensitivity.jl, SciMLDocs.jl, and DiffEqGPU.jl, which require GPUs as part of the documentation build and thus are run on the Buildkite instead of Github Actions. Some of them are just really long builds too (SciMLSensitivity We would like to put the high level SciMLDocs (with its new showcase!) onto many packages (since those are the first tutorials everyone will see), so if that requires GPU, then the system really needs to be able to use GPUs, at least for some of the tests.
For that, I might need the help of @thazhemadam @staticfloat to maybe get some thing I can paste into some Buildkite scripts?
(Note: since it won't need deployment it won't need the help with the cryptographic signatures stuff, thank god)
@ChrisRackauckas to be clear, the expectation here is that the documentation for every single downstream package (i.e., all packages whose docs get aggregated on docs.sciml.ai) needs to be run, to ensure that documentation for these respective packages build, right?
If yes, won't this happen when we're running the MultiDocumenter.make itself? I'm not sure I understand the benefit of running the same thing twice.
the expectation here is that the documentation for every single downstream package (i.e., all packages whose docs get aggregated on docs.sciml.ai) needs to be run, to ensure that documentation for these respective packages build, right?
No. OrdinaryDiffEq tests (https://github.com/SciML/OrdinaryDiffEq.jl/pull/1813) run downstream tests on things like SciMLSensitivity.jl. However, those do not include the tutorials in the SciMLSensitivity.jl documentation. OrdinaryDiffEq.jl should run the downstream SciMLSensitivity.jl test suite and its tutorial runs.