search

CliMA / LESbrary.jl

📚Generating Oceananigans large eddy simulation (LES) data for calibrating parameterizations
MIT License
28 stars 10 forks source link

Adds basic documentation #74

Closed glwagner closed 2 years ago

glwagner commented 3 years ago

Starts up some basic documentation.

I think it'd be great to document the diagnostics / ComputedFields that LESbrary.jl provides. I also think we can write up a basic explanation of the LESbrary.jl methodology for reference and also to encourage some discussion.

glwagner commented 3 years ago

@ali-ramadhan do we need to add a block to https://github.com/CliMA/LESbrary.jl/blob/master/.github/workflows/ci.yml to get the docs to build during CI?

I think we'll also want to create a dedicated repository for doc builds (like OceananigansDocumentation) at some point but its not urgent.

ali-ramadhan commented 3 years ago

Yes I just took https://github.com/ali-ramadhan/DocumenterCitations.jl/blob/master/.github/workflows/Docs.yml and copied it into this branch.

Should work out of the box but we might need to generate a Documenter key and/or GitHub token.

navidcy commented 2 years ago

Should we merge this? Shall I have a look?

glwagner commented 2 years ago

I suppose we should!

glwagner commented 2 years ago

Stale, let's revisit.