ESCOMP / ESCOMP/CTSM

Incorporate documentation of namelist variables in our sphinx-based documentation

Open
#1,061 3 comments 0 reactions 0 assignees View on GitHub
docs-loc:infrastructure docs-loc:users-guide docs:infrastructure documentation
Dominant language
Fortran
Stars
352
Forks
361
Avg merge
2d 21h
Merged PRs (30d)
7

Description

Currently, we rely on http://www.cesm.ucar.edu/models/cesm2/settings/current/clm5_0_nml.html for documentation of our namelist variables. However, this is tied to CESM releases, so is out-of-date with respect to the available options in the latest version of CTSM.

We should consider incorporating documentation of these namelist variables in our sphinx-based documentation, or coming up with some other mechanism to keep a version of this documentation up-to-date with master as well as other supported versions of CTSM.

(This issue occurred to me while documenting CTSM-LILAC: I started to point to the above page, but then realized that it isn't completely accurate.)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.