All projects have their own scientific and technical documentation. Most notably:
| UM Documentation Papers | view UM |
| JULES User Guide | view JULES |
| LFRic Core | view LFRic Core |
| LFRic Apps | view LFRic Apps |
Increasingly this documentation is stored as restructuredText markdown files alongside the code. This is then compiled using Sphinx into the webpages above.
.. toctree::
:maxdepth: 1
sphinx_docs
um_docs
jules_docs
update with relevant UM details. Add a page to the toctree above?
The UM documentation papers are written in LaTeX and stored in a separate repository. Guidelines for editing the UM documentation papers are available here
.._ umdp: https://code.metoffice.gov.uk/trac/um/wiki/WorkingPractices/Documentation/UpdatingUMDPs
LFRic Apps and Core also use doxygen to document the code and all changes should include appropriate doxygen changes to go with them. Doxygen guidelines are available in the LFRic Core Documentation.
Small changes and bug fixes rarely need documentation to be updated, but when new science is added to a project, the documentation must be updated to ensure that it remains contemporary with the code.
Documentation changes that are held within a repository should be documented with issues and pull requests, are formally reviewed, and should be included on the same branch as the code changes. Apply the Documentation label to your pull request.
Tip
Searching the relevant documentation for words related to your change is often useful when deciding whether to update the documentation.