-
Notifications
You must be signed in to change notification settings - Fork 186
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Can we build examples separately from makedocs
?
#2309
Comments
I don't know this fits here, but I was thinking about a way to have a separate repository for examples from community that doesn't affect the test running time of the main repo. The repo could generate a wiki-like page with the examples. We could give a code template for the simulations. For instance, all simulations must inform and check the version of Oceananigans and it's dependencies. Or maybe containing a yml equivalent for Julia project. What do you guys think? I know this can get messy.. but it could be a nice way to avoid people reinventing the wheel while making their own simulations. With enough time, almost any experiment will have some others similar. |
I think we'll want a "community repo" for cases eventually. Something like https://github.com/FluxML/model-zoo if I understand the purpose of that correctly.
Isn't an ordinary Julia environment enough? For the community repo I think either
As I understand the flux model zoo takes approach 1 (this is in principle better, because otherwise the examples grow stale and cease to be useful). However, that requires maintenance and substantial effort. I think we will still want in-house examples in addition to an external community repo. |
Duplicate of #1053 |
Our suite of examples is fairly expensive; in recent runs the documentation build exceeds 90 minutes.
If we're able to "build" the examples first, before calling
makedocs
:Oceananigans.jl/docs/make.jl
Lines 155 to 165 in 8da72d1
we can probably speed up the build. This is crucial now because we need to add new examples both for
HydrostaticFreeSurfaceModel
and for simulations in complex domains viaImmersedBoundaryGrid
. We can also move some examples to the GPU and either speed them up, run them at higher resolution, or both.What I know now: we provide
.md
files tomakedocs
, which then expands code blocks and generates.html
:Oceananigans.jl/docs/make.jl
Line 66 in 8da72d1
Oceananigans.jl/docs/make.jl
Line 133 in 8da72d1
Oceananigans.jl/docs/make.jl
Line 159 in 8da72d1
I think one solution is to generate the
.html
(by running code, which generates images and animations + links in thehtml
) in separate buildkite jobs, and then somehow generate links to the pre-built.html
in the "primary"make.jl
call tomakedocs
beforedeploydocs
.The text was updated successfully, but these errors were encountered: