Clean up documentation for chgres.

Issue ufs-community#835.
GeorgeGayno-NOAA · Aug 30, 2023 · 0b62d20 · 0b62d20
1 parent 4656e9f
commit 0b62d20
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/sorc/chgres_cube.fd/docs/Doxyfile.in b/sorc/chgres_cube.fd/docs/Doxyfile.in
@@ -854,7 +854,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @abs_top_srcdir@/sorc/chgres_cube.fd/docs/user_guide.md \
+INPUT                  = @abs_top_srcdir@/sorc/chgres_cube.fd/docs/chgres_cube.md \
                          @abs_top_srcdir@/sorc/chgres_cube.fd
 
 # This tag can be used to specify the character encoding of the source files
@@ -1015,7 +1015,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = user_guide.md
+USE_MDFILE_AS_MAINPAGE = chgres_cube.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

diff --git a/sorc/chgres_cube.fd/docs/README.md b/sorc/chgres_cube.fd/docs/README.md
@@ -0,0 +1,4 @@
+The chgres_cube program creates initial condition files to coldstart
+the forecast model. 
+
+Documentation may be found at https://ufs-community.github.io/UFS_UTILS
diff --git a/sorc/chgres_cube.fd/docs/user_guide.md → sorc/chgres_cube.fd/docs/chgres_cube.md b/sorc/chgres_cube.fd/docs/user_guide.md → sorc/chgres_cube.fd/docs/chgres_cube.md