Use PrettyTables for Available Diagnostics docs

.gitignore

@@ -22,9 +22,6 @@ deps/src/
 docs/build/
 docs/site/
 
-# File generated by make_available_diagnostics.jl
-docs/src/available_diagnostics.md
-
 # File generated by Pkg, the package manager, based on a corresponding Project.toml
 # It records a fixed state of all packages used by the project. As such, it should not be
 # committed for packages, but should be committed for applications that require a static

docs/make.jl

@@ -10,7 +10,6 @@ bib = CitationBibliography(joinpath(@__DIR__, "bibliography.bib"))
 doctest(ClimaAtmos; plugins = [bib])
 disable_logging(Base.CoreLogging.BelowMinLevel) # Re-enable all logging
 
-include("make_diagnostic_table.jl")
 makedocs(;
     plugins = [bib],
     modules = [ClimaAtmos],

docs/src/available_diagnostics.md

@@ -0,0 +1,6 @@
+# Available diagnostic variables
+
+Autogenerate table of available diagnostics:
+```@example
+include("make_diagnostic_table.jl")
+```

docs/src/make_diagnostic_table.jl

@@ -0,0 +1,27 @@
+import ClimaAtmos as CA
+using PrettyTables
+
+# Print all available diagnostics to an ASCII table
+
+short_names = []
+long_names = []
+units = []
+comments = []
+standard_names = []
+for d in values(CA.Diagnostics.ALL_DIAGNOSTICS)
+    push!(short_names, d.short_name)
+    push!(long_names, d.long_name)
+    push!(units, d.units)
+    push!(comments, d.comments)
+    push!(standard_names, d.standard_name)
+end
+data = hcat(short_names, long_names, units, comments, standard_names)
+pretty_table(
+    data;
+    autowrap = true,
+    linebreaks = true,
+    columns_width = [10, 15, 8, 32, 15],  # Width = 80
+    body_hlines = collect(1:size(data)[1]),
+    header = ["Short name", "Long name", "Units", "Comments", "Standard name"],
+    alignment = :l,
+)