From fe24ec777c82dfea0dccb092cb2d1732f0846393 Mon Sep 17 00:00:00 2001 From: George Gayno Date: Fri, 1 Sep 2023 19:33:22 +0000 Subject: [PATCH] Updates for sfc_climo_gen. Fixes #835. --- sorc/sfc_climo_gen.fd/docs/Doxyfile.in | 4 ++-- sorc/sfc_climo_gen.fd/docs/README.md | 4 ++++ .../sfc_climo_gen.fd/docs/{user_guide.md => sfc_climo_gen.md} | 0 3 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 sorc/sfc_climo_gen.fd/docs/README.md rename sorc/sfc_climo_gen.fd/docs/{user_guide.md => sfc_climo_gen.md} (100%) diff --git a/sorc/sfc_climo_gen.fd/docs/Doxyfile.in b/sorc/sfc_climo_gen.fd/docs/Doxyfile.in index 36fb2baa8..7f35e9ec1 100644 --- a/sorc/sfc_climo_gen.fd/docs/Doxyfile.in +++ b/sorc/sfc_climo_gen.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/sfc_climo_gen.fd/docs/user_guide.md \ +INPUT = @abs_top_srcdir@/sorc/sfc_climo_gen.fd/docs/sfc_climo_gen.md \ @abs_top_srcdir@/sorc/sfc_climo_gen.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 = sfc_climo_gen.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/sorc/sfc_climo_gen.fd/docs/README.md b/sorc/sfc_climo_gen.fd/docs/README.md new file mode 100644 index 000000000..93388c9e8 --- /dev/null +++ b/sorc/sfc_climo_gen.fd/docs/README.md @@ -0,0 +1,4 @@ +This program creates climatological surface fields on the model grid, +such as soil type and albedo. + +Documentation may be found at https://ufs-community.github.io/UFS_UTILS diff --git a/sorc/sfc_climo_gen.fd/docs/user_guide.md b/sorc/sfc_climo_gen.fd/docs/sfc_climo_gen.md similarity index 100% rename from sorc/sfc_climo_gen.fd/docs/user_guide.md rename to sorc/sfc_climo_gen.fd/docs/sfc_climo_gen.md