Skip to content

Commit 7be0a09

Browse files
hertnekymzhangwgrantfirl
authored
New SciDocs for GWv1 release and LandDA capability (NCAR#1226)
* add doxygen action * minor changes * minor changes * minor changes * doxy only * Create main.yml * Create jekyll-gh-pages.yml * change * add doxyfile into wkfl * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update ccpp_doxyfile * Update ccpp_doxyfile * update ccpp doxyfile * Update doxygen.yml * update doxyfile * Update doxygen.yml * Update doxygen.yml * update doxyfile * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * change path * add mactex * add mactex * minor changes * minor fix * try1 * try1 * try2 * updates * update perl * update perl * update path * explicitly install * updates * updates * fix * fix path * fix * fix path * fixes * fix3 * cleanup * restore yml files * hsd updates * add doxygen.yml * update branch * update wflw * test * fix * fix * fix * fix * rearrange steps * oops * . * debug * chng dir * chng dir * chng dir * -landing page * -update para * try to add a backlink, fix typo * fix css link * link path * try cp stylesheet * Add CCPP website * fix * add SRW build, backlink * try mainpage * changes for mainpage * mainpage config * mainpage config * mainpage config * mainpage debug * mainpage debug * mainpage debug * mainpage debug * mainpage debug * fix landing page sidebar. * fix landing page sidebar. * fix landing page sidebar. * fix landing page sidebar. * style updates * mainpage style * mainpage style * hide tree on mainpage * add back tree * try adding backlink * add backlink to other pages * updates migrated from mzhangw * fix missed conflicts * fix syntax * run workflow on this branch * remove branch from workflow run, update doxyfile * mods to mainpag dxy * updates * try update for v7 arg table * turn on scidoc branch for deploy * recurse checkout * fix directory * try fix * update landing page with acknowledgements * fix path * fix path * debug * add prebuild_config for building tables * fix * debug * debug * restructure workflow to work with metadata2html.py * add remaining prebuild configs * attempt fix srwv3 checkout * fix main checkout for landing page, stash prebuild configs * fix syntax * update prebuild location * workflow updates * point to NCAR/main * initial landDA sciDoc commits * point to fork for testing * point to fork for testing in 1 more place * add sciDocs for GW release, some reorg * point to fork * remove main * Changes to GW mainpage * try fix * fix! * fix few things * Add nml links * fix land DA overview page * fixes * oops * oops * updates to GFS_ugwpv1 from Michael Toy and Bo Yang * updates to SAMFdeep from Lisa Bengtsson * updates from Jongil Han for convective, sfc, pbl schemes * Update SciDoc link on README * updates for H2O/Ozone schemes from Qingfu Lui * fix sfclyr link * update reference * try bib fix * try bib tweak * trying to get ref to work * fix bib links * updates for RRTMG from Qingfu Lui * update tracy-fork > main for merging into NCAR/main --------- Co-authored-by: mzhangw <man.zhang@noaa.gov> Co-authored-by: mzhangw <mzhangw@gmail.com> Co-authored-by: Grant Firl <grant.firl@noaa.gov>
1 parent ef0211a commit 7be0a09

30 files changed

Lines changed: 7404 additions & 158 deletions

.github/workflows/doxygen.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,20 @@ jobs:
6565
mkdir -p $GITHUB_WORKSPACE/physics/docs/html/HSD
6666
mv doc/html/* $GITHUB_WORKSPACE/physics/docs/html/HSD
6767
68+
- name: Build GW docs
69+
run: |
70+
cd scm_repo/ccpp/physics/physics/docs
71+
doxygen ccppgw_doxyfile
72+
mkdir -p $GITHUB_WORKSPACE/physics/docs/html/GWv1
73+
mv doc/html/* $GITHUB_WORKSPACE/physics/docs/html/GWv1
74+
75+
- name: Build Land DA docs
76+
run: |
77+
cd scm_repo/ccpp/physics/physics/docs
78+
doxygen ccpplandda_doxyfile
79+
mkdir -p $GITHUB_WORKSPACE/physics/docs/html/LandDA
80+
mv doc/html/* $GITHUB_WORKSPACE/physics/docs/html/LandDA
81+
6882
- name: Switch to v7 tag
6983
run: |
7084
cd scm_repo

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Please see more information about the CCPP at the locations below.
77
- [CCPP website hosted by the Developmental Testbed Center (DTC)](https://dtcenter.org/ccpp)
88
- [CCPP public release information](https://dtcenter.org/community-code/common-community-physics-package-ccpp/download)
99
- [CCPP Technical Documentation](https://ccpp-techdoc.readthedocs.io/en/v6.0.0/)
10-
- [CCPP Scientific Documentation](https://dtcenter.ucar.edu/GMTB/v6.0.0/sci_doc/index.html)
10+
- [CCPP Scientific Documentation](https://ncar.github.io/ccpp-physics/)
1111
- [CCPP Physics GitHub wiki](https://github.com/NCAR/ccpp-physics/wiki)
1212
- [CCPP Framework GitHub wiki](https://github.com/NCAR/ccpp-framework/wiki)
1313

physics/docs/ccppgw_doxyfile

Lines changed: 2902 additions & 0 deletions
Large diffs are not rendered by default.

physics/docs/ccpphsd_doxyfile

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -984,15 +984,15 @@ WARN_LOGFILE =
984984
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
985985
# Note: If this tag is empty the current directory is searched.
986986

987-
INPUT = pdftxt/HSD_overview.txt \
988-
pdftxt/Idealized_TC.txt \
989-
pdftxt/Aquaplanet.txt \
990-
pdftxt/HAFS_TC_suite.txt \
991-
pdftxt/GFS_v17_p8_ugwpv1_aquaplanet_suite.txt \
987+
INPUT = pdftxt/HSD/HSD_overview.txt \
988+
pdftxt/HSD/Idealized_TC.txt \
989+
pdftxt/HSD/Aquaplanet.txt \
990+
pdftxt/HSD/HAFS_TC_suite.txt \
991+
pdftxt/HSD/GFS_v17_p8_ugwpv1_aquaplanet_suite.txt \
992992
pdftxt/suite_input.nml.txt \
993993
pdftxt/acronyms.txt \
994994
pdftxt/GFS_RRTMG.txt \
995-
pdftxt/GFS_SFCLYR.txt \
995+
pdftxt/GFS_v17_SFCLYR.txt \
996996
pdftxt/GFS_NSST.txt \
997997
pdftxt/GFS_OCEAN.txt \
998998
pdftxt/NOAH_LSM.txt \

0 commit comments

Comments
 (0)