Closed glwagner closed 2 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.
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.
Should we merge this? Shall I have a look?
I suppose we should!
Stale, let's revisit.
Starts up some basic documentation.
I think it'd be great to document the diagnostics /
ComputedField
s thatLESbrary.jl
provides. I also think we can write up a basic explanation of theLESbrary.jl
methodology for reference and also to encourage some discussion.