NCAR / DART

Data Assimilation Research Testbed
https://dart.ucar.edu/
Apache License 2.0
189 stars 142 forks source link

doc notes fluxnetfull, lorenz_96_tracer_advection, clm #546

Closed hkershaw-brown closed 10 months ago

hkershaw-brown commented 11 months ago

Hit this while building docs for pull #545 https://docs.dart.ucar.edu/en/latest/observations/obs_converters/Ameriflux/level4_to_obs.html

/Users/hkershaw/DART/pull_requests/pull_545/observations/obs_converters/Ameriflux/fluxnetfull_to_obs.rst: WARNING: document isn't included in any toctree

/Users/hkershaw/DART/pull_requests/pull_545/observations/obs_converters/Ameriflux/level4_to_obs.rst:10: WARNING: unknown document: './Fluxnetfull_to_obs'

Also these have been hanging out for a while:

/Users/hkershaw/DART/pull_requests/pull_545/models/clm/readme.rst:749: WARNING: Footnote [1] is not referenced.
/Users/hkershaw/DART/pull_requests/pull_545/models/clm/readme.rst:755: WARNING: Footnote [2] is not referenced.
/Users/hkershaw/DART/pull_requests/pull_545/models/clm/readme.rst:761: WARNING: Footnote [3] is not referenced.
/Users/hkershaw/DART/pull_requests/pull_545/models/clm/readme.rst:767: WARNING: Footnote [4] is not referenced.
/Users/hkershaw/DART/pull_requests/pull_545/models/clm/readme.rst:778: WARNING: Footnote [6] is not referenced.
/Users/hkershaw/DART/pull_requests/pull_545/models/clm/readme.rst:784: WARNING: Footnote [7] is not referenced.
/Users/hkershaw/DART/pull_requests/pull_545/models/clm/readme.rst:789: WARNING: Footnote [8] is not referenced.
/Users/hkershaw/DART/pull_requests/pull_545/models/lorenz_96_tracer_advection/readme.rst:66: ERROR: Unexpected indentation.
/Users/hkershaw/DART/pull_requests/pull_545/models/lorenz_96_tracer_advection/readme.rst:67: WARNING: Block quote ends without a blank line; unexpected unindent.
hkershaw-brown commented 11 months ago

To build the dart documentation on your machine you will need sphinx:

https://ncar.github.io/dart-developers-guide/documentation.html#installing-sphinx-locally

Sphinx==6.2.1 sphinx-rtd-theme==1.2.2

c-merchant commented 10 months ago

Only the warnings with Ameriflux/fluxnetfull_to_obs, template/new_model, and models/lorenz_96_tracer_advection remain.