Updates for global_cycle and grid_tools.

Fixes ufs-community#835.
GeorgeGayno-NOAA · Sep 1, 2023 · 416cc38 · 416cc38
1 parent ca97bce
commit 416cc38
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 4 deletions.
diff --git a/sorc/global_cycle.fd/docs/Doxyfile.in b/sorc/global_cycle.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/global_cycle.fd/docs/user_guide.md \
+INPUT                  = @abs_top_srcdir@/sorc/global_cycle.fd/docs/global_cycle.md \
                          @abs_top_srcdir@/sorc/global_cycle.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 = global_cycle.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

diff --git a/sorc/global_cycle.fd/docs/README.md b/sorc/global_cycle.fd/docs/README.md
@@ -0,0 +1,5 @@
+This program updates the GFS surface conditions using
+external snow and sea ice analyses. It updates monthly climatological
+fields such as plant greenness fraction and albedo.
+
+Documentation may be found at https://ufs-community.github.io/UFS_UTILS
diff --git a/sorc/global_cycle.fd/docs/user_guide.md → sorc/global_cycle.fd/docs/global_cycle.md b/sorc/global_cycle.fd/docs/user_guide.md → sorc/global_cycle.fd/docs/global_cycle.md
diff --git a/sorc/grid_tools.fd/docs/Doxyfile.in b/sorc/grid_tools.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/grid_tools.fd/docs/user_guide.md \
+INPUT                  = @abs_top_srcdir@/sorc/grid_tools.fd/docs/grid_tools.md \
                          @abs_top_srcdir@/sorc/grid_tools.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 = grid_tools.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

diff --git a/sorc/grid_tools.fd/docs/README.md b/sorc/grid_tools.fd/docs/README.md
@@ -0,0 +1,3 @@
+Utility programs for creating model grids.
+
+Documentation may be found at https://ufs-community.github.io/UFS_UTILS
diff --git a/sorc/grid_tools.fd/docs/user_guide.md → sorc/grid_tools.fd/docs/grid_tools.md b/sorc/grid_tools.fd/docs/user_guide.md → sorc/grid_tools.fd/docs/grid_tools.md