build-docs
Skill1.4k starsChanged 9 days agoMITView on GitHub
Build Oceananigans documentation locally with optional fast-build shortcuts
4 other projects use a version of this, 1 of them edited.
Trending
More talk lately.about the whole repository
Most recently taken up by
- NathanForster/claude-commandstheir own version, first seen Nov 1, 2026
- NumericalEarth/Breeze.jledited, first seen Oct 17, 2026
- olorehq/oloretheir own version, first seen Mar 20, 2026
- microsoft/semantic-link-labstheir own version, first seen Feb 12, 2026
Who's talking about CliMA/Oceananigans.jl
- @navidcy.bsky.social“This 👇🏼 is open for another 6 days! 🌊 🌏 Not sure if this is for you? Want to find more about the …”Bluesky · Nov 20, 2024 · 21 likes
- @navidcy.bsky.social“Very excited to see our figure on the JFM cover!! large-eddy simulation run with @julialang.org software …”Bluesky · Oct 17, 2025 · 11 likes
- NumericalEarth/NumericalEarth.jl“Clean up `examples/` + create `validation/`”GitHub · Jul 29, 2026 · 3 reactions
- JuliaLang/julia“Package precompilation suddenly hangs on 1.5.4 without direct code changes”GitHub · Apr 13, 2021 · 3 reactions
- NumericalEarth/Breeze.jl“Implement checkpointing for `AtmosphereModel`”GitHub · Feb 27, 2026 · 2 reactions
The biggest 5 of 48 mentions linking to the repository that our crawl found. Each line is their own headline.
See all 48
Talked about on GitHub, Bluesky and Hacker News (48 times).
On GitHub · 45
- Jul 29, 2026Clean up `examples/` + create `validation/` — NumericalEarth/NumericalEarth.jl3 reactions · 6 comments
- Apr 13, 2021Package precompilation suddenly hangs on 1.5.4 without direct code changes — JuliaLang/julia3 reactions · 3 comments
- Feb 27, 2026Implement checkpointing for `AtmosphereModel` — NumericalEarth/Breeze.jl2 reactions · 26 comments
- Nov 21, 2025Implement a buoyancy frequency (squared) functionality that is "cloudy-region-aware" — NumericalEarth/Breeze.jl2 reactions · 2 comments
- Sep 13, 2025OceananiganPythonInterface or ClimaOceanPythonInterface auxiliary package for collecting PythonCall utilities? — CliMA/ClimaOcean.jl2 reactions · 5 comments
40 more on GitHub
- Oct 29, 2026Implement and test checkpointing for biogeochemistry models — OceanBioME/OceanBioME.jl1 reaction
- Oct 20, 2026Test the impact of storing reciprocal metrics — NumericalEarth/Breeze.jl1 reaction · 12 comments
- Oct 16, 2026POCL: reduce launch memory allocations — JuliaGPU/KernelAbstractions.jl1 reaction · 2 comments
- Sep 24, 2026Use Julia 1.13 for Buildkite tests — OceanBioME/OceanBioME.jl1 reaction
- Aug 27, 2026Fix compatibility with Oceananigans v0.110.20 — NumericalEarth/Breeze.jl1 reaction · 3 comments
- Aug 3, 2026Remove dev'd Oceananigans.jl — NumericalEarth/Breeze.jl1 reaction · 1 comment
- Jun 3, 2026Antimeridian-aware `contour`/`contourf` on `GeoAxis` (incl. curvilinear/tripolar grids) — MakieOrg/GeoMakie.jl1 reaction · 1 comment
- Apr 9, 2026Documentation fixes and improvements — NumericalEarth/Terrarium.jl1 reaction · 6 comments
- Apr 2, 2026Implement fast_div using fast rcp — JuliaGPU/CUDA.jl1 reaction · 9 comments
- Jan 30, 2026Update Julia packages to latest version — tomchor/rough-seamounts1 reaction
- Nov 9, 2025Update Oceananigans requirement to 0.100.7 in /docs — NumericalEarth/Breeze.jl1 reaction · 5 comments
- Nov 3, 2025Aliasscope miss-compile for 1.11+ — JuliaGPU/KernelAbstractions.jl1 reaction · 3 comments
- Oct 2, 2025Changes `ExponentialCoordinate` to `ExponentialDiscretization` — CliMA/ClimaOcean.jl1 reaction · 11 comments
- Aug 28, 2025Invalid kernel config generated by `mapreducedim!` with `SubArray` input and output — JuliaGPU/CUDA.jl1 reaction · 3 comments
- Apr 14, 2025Register this package? — JuliaGeo/ConservativeRegridding.jl1 reaction · 5 comments
- Mar 15, 2025[CI] Some improvements to GitHub Actions setup — CliMA/ClimaOcean.jl1 reaction · 5 comments
- Nov 16, 2024Add small (molecular?) background diffusivity on top of Smag-Lilly eddy diffusivity — hdrake/internal-tide-mixing1 reaction · 2 comments
- Dec 8, 2022Check if NetCDF_jll `is_available` before loading code — JuliaGeo/NCDatasets.jl1 reaction · 3 comments
- Jul 8, 2021Detect common integer exponentiations and handle them directly. — JuliaGPU/CUDA.jl1 reaction · 3 comments
- May 21, 2021Error when computing reductions into a view with `reduce_blocks > 1` — JuliaGPU/CUDA.jl1 reaction · 6 comments
- Mar 5, 2021Using joblib to parallelize plotting — jbusecke/xmovie1 reaction · 8 comments
- Jul 2, 2020Make Ref pass by-reference — JuliaGPU/CUDA.jl1 reaction · 5 comments
- Oct 31, 2026Update Oceananigans requirement from 0.113, 0.114 to 0.113, 0.114, 0.116 — agate-model/Agate.jl0 reactions
- Oct 21, 2026Update Oceananigans requirement from 0.113 to 0.113, 0.114 in /test — aria-verify/Assimilate.jl0 reactions
- Oct 21, 2026Update Oceananigans requirement from 0.113 to 0.113, 0.114 in /docs — aria-verify/Assimilate.jl0 reactions
- Oct 21, 2026Update Oceananigans requirement from 0.113 to 0.113, 0.114 — aria-verify/Assimilate.jl0 reactions
- Mar 13, 2026Make docs build faster by running examples in parallel — CliMA/CloudMicrophysics.jl0 reactions
- Feb 19, 2026STATUS: Differentiating Breeze — NumericalEarth/Breeze.jl0 reactions
- Jan 16, 2026Overlay methods on top of CUDA.jl method table — EnzymeAD/Reactant.jl0 reactions · 1 comment
- Nov 10, 2025Open boundary conditions with boundary mass flux correction — NumericalEarth/Breeze.jl0 reactions · 1 comment
- Aug 6, 2025Support Julia LTS version — googlecolab/colabtools0 reactions · 2 comments
- Jul 15, 2025Version and thread check at init — fesmc/Pagos.jl0 reactions
- Jun 16, 2025Error in ECCO dataset download — CliMA/ClimaOcean.jl0 reactions · 30 comments
- Jun 8, 2025Package notation differs from Oceananigans — tomchor/Oceanostics.jl0 reactions · 9 comments
- Apr 23, 2025Test with new weno reconstruction — simone-silvestri/NVIDIA_benchmark_tests0 reactions · 1 comment
- Sep 27, 2023Have we tried using `Field` as boundary condition? — yuchenma23/RT_tracer0 reactions
- Jun 13, 2022Use `.dataset` rather than `.field_time_serieses`? — CliMA/ParameterEstimocean.jl0 reactions · 1 comment
- Mar 9, 2022Can saved output be improved? — navidcy/mesoscale-parametrization0 reactions · 5 comments
- Feb 7, 2022Oceananigans.jl ocean modeling example — ClimateMARGO/interactive0 reactions · 4 comments
- Sep 27, 2020Milestones until we can submit a JOSS paper? — ali-ramadhan/Atmosfoolery.jl0 reactions · 2 comments
On Bluesky · 2
- Nov 20, 2024This 👇🏼 is open for another 6 days! 🌊 🌏 Not sure if this is for you? Want to find more about the project? Are you on the fence? Do… — @navidcy.bsky.social21 likes and reposts
- Oct 17, 2025Very excited to see our figure on the JFM cover!! large-eddy simulation run with @julialang.org software Oceananigans.jl;… — @navidcy.bsky.social11 likes and reposts
On Hacker News · 1
- May 26, 2020Oceananigans.jl: fast and friendly fluid dynamics on CPUs and GPUs2 points
Other versions4 projects use a version of this.
Word for word · 0
None found.
Edited · 1
- NumericalEarth/Breeze.jl★ 9071% same
Wrote their own version · 3
- microsoft/semantic-link-labs★ 594same name
- olorehq/olore★ 114same name
- NathanForster/claude-commands★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository5 other files it gives its agents.
- AGENTS.mdAGENTS.md
- add-featureSkill
- babysit-ciSkill
- new-simulationSkill
- run-testsSkill
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.
0
Common
Most of the 4 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 12
Ask the user if they want a full build or a fast build (skipping examples)
- Very specific: line 35
Always revert temporary changes to docs/make.jl before committing
“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Build Documentation
Build the Oceananigans documentation locally.
Steps
- Ask the user if they want a full build or a fast build (skipping examples)
- For full build:
julia --project=docs/ docs/make.jl - For fast build, temporarily modify
docs/make.jl:- Comment out Literate examples in
example_scriptsandexample_pages - Add
warnonly = [:cross_references, :example_block, :linkcheck] - Comment out GPU-requiring pages
- Optionally set
linkcheck = false,draft = true - Run the build
- Revert all changes to
docs/make.jlafter building
- Comment out Literate examples in
- Serve docs locally for preview:
using LiveServer serve(dir="docs/build") - Report any warnings or errors from the build
Notes
- Fast builds skip examples - use for checking prose and cross-references only
- Doctests are not part of the docs build; run them with the
doctests/docteststest (needs a GPU) - Always revert temporary changes to
docs/make.jlbefore committing
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

