Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
a0f17b5
add doxygen action
mzhangw Feb 19, 2026
55af499
minor changes
mzhangw Feb 19, 2026
1b04bbb
minor changes
mzhangw Feb 19, 2026
5c382be
minor changes
mzhangw Feb 19, 2026
14c12a2
doxy only
mzhangw Feb 19, 2026
6e6251f
Create main.yml
mzhangw Feb 19, 2026
88c42d8
Create jekyll-gh-pages.yml
mzhangw Feb 19, 2026
3bc16e7
change
mzhangw Feb 20, 2026
e213b4f
add doxyfile into wkfl
mzhangw Feb 20, 2026
173a0a2
Update doxygen.yml
mzhangw Feb 20, 2026
639e095
Update doxygen.yml
mzhangw Feb 20, 2026
65ff7c5
Update doxygen.yml
mzhangw Feb 20, 2026
0153ff9
Update doxygen.yml
mzhangw Feb 20, 2026
4eaf41c
Update doxygen.yml
mzhangw Feb 20, 2026
0fb88e9
Update doxygen.yml
mzhangw Feb 20, 2026
310afbf
Update doxygen.yml
mzhangw Feb 20, 2026
7efd81d
Update doxygen.yml
mzhangw Feb 20, 2026
f926b72
Update doxygen.yml
mzhangw Feb 20, 2026
94bb4aa
Update doxygen.yml
mzhangw Feb 20, 2026
2d643c9
Update doxygen.yml
mzhangw Feb 20, 2026
8d3cbea
Update doxygen.yml
mzhangw Feb 20, 2026
d706260
Update ccpp_doxyfile
mzhangw Feb 20, 2026
86bfbf3
Update ccpp_doxyfile
mzhangw Feb 20, 2026
41c0a24
update ccpp doxyfile
mzhangw Feb 20, 2026
f33cc26
Update doxygen.yml
mzhangw Feb 20, 2026
00675dd
update doxyfile
mzhangw Feb 20, 2026
4cc5c34
Merge branch 'dox' of https://github.com/mzhangw/ccpp-physics into dox
mzhangw Feb 20, 2026
a01a78c
Update doxygen.yml
mzhangw Feb 20, 2026
e16205e
Update doxygen.yml
mzhangw Feb 20, 2026
9b66245
update doxyfile
mzhangw Feb 20, 2026
53eef3b
Update doxygen.yml
mzhangw Feb 20, 2026
6df1bb3
Update doxygen.yml
mzhangw Feb 20, 2026
3d47ce1
Update doxygen.yml
mzhangw Feb 20, 2026
1d07030
Update doxygen.yml
mzhangw Feb 20, 2026
176fe1e
Update doxygen.yml
mzhangw Feb 20, 2026
1faec18
Update doxygen.yml
mzhangw Feb 20, 2026
7085923
Update doxygen.yml
mzhangw Feb 20, 2026
6cb2d89
Update doxygen.yml
mzhangw Feb 20, 2026
47194cc
Update doxygen.yml
mzhangw Feb 20, 2026
c72cd1c
Update doxygen.yml
mzhangw Feb 20, 2026
ecc2800
Update doxygen.yml
mzhangw Feb 20, 2026
fc5bce8
Update doxygen.yml
mzhangw Feb 20, 2026
1c7c894
Update doxygen.yml
mzhangw Feb 20, 2026
b86f88d
Update doxygen.yml
mzhangw Feb 20, 2026
1c4915c
Update doxygen.yml
mzhangw Feb 20, 2026
215530d
Update doxygen.yml
mzhangw Feb 20, 2026
172a54e
Update doxygen.yml
mzhangw Feb 20, 2026
18ce313
Update doxygen.yml
mzhangw Feb 20, 2026
b28864c
Update doxygen.yml
mzhangw Feb 20, 2026
1d8385c
Update doxygen.yml
mzhangw Feb 20, 2026
33208f2
Update doxygen.yml
mzhangw Feb 20, 2026
1d84e14
Update doxygen.yml
mzhangw Feb 20, 2026
d92218b
Update doxygen.yml
mzhangw Feb 20, 2026
eef0f52
Update doxygen.yml
mzhangw Feb 20, 2026
da49569
change path
mzhangw Feb 20, 2026
a3b4725
Merge branch 'dox' of https://github.com/mzhangw/ccpp-physics into dox
mzhangw Feb 20, 2026
ff53895
add mactex
mzhangw Feb 20, 2026
117d82e
add mactex
mzhangw Feb 20, 2026
213f61f
minor changes
mzhangw Feb 20, 2026
724e40b
minor fix
mzhangw Feb 20, 2026
40035aa
try1
mzhangw Feb 20, 2026
c8afcc5
try1
mzhangw Feb 20, 2026
0095d8d
try2
mzhangw Feb 21, 2026
ecd6dcb
updates
mzhangw Feb 21, 2026
594fbeb
update perl
mzhangw Feb 21, 2026
f408aa2
update perl
mzhangw Feb 21, 2026
bdc1673
update path
mzhangw Feb 21, 2026
f79ebeb
explicitly install
mzhangw Feb 23, 2026
fc55094
updates
mzhangw Feb 23, 2026
20c1621
updates
mzhangw Feb 23, 2026
8cee5bc
fix
mzhangw Feb 23, 2026
ef9ffa4
fix path
mzhangw Feb 23, 2026
6b58aef
fix
mzhangw Feb 23, 2026
c2501d1
fix path
mzhangw Feb 23, 2026
12ad2ba
fixes
mzhangw Feb 23, 2026
84689f2
fix3
mzhangw Feb 23, 2026
0368f65
cleanup
mzhangw Feb 23, 2026
2e51931
restore yml files
mzhangw Feb 23, 2026
cd5ba76
Merge branch 'main' into dox
grantfirl Mar 12, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 107 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
name: Doxygen GitHub Pages Deploy Action

on:
push:
branches:
- main

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add workflow_dispatch: as a trigger so that this can be run via GitHub if necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@grantfirl I may be misunderstanding your point. The Doxygen HTML automation is configured through Settings → Code and automation → Pages after this PR is merged into the NCAR repository. With the current setup, the workflow automatically rebuilds and refreshes the website whenever there is a new push. Right now, it is triggered by a push to main (though that trigger may not be optimal).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, that sounds good. I was just thinking that it would be nice to be able to initiate the documentation generation with pushing something to main, but it sounds like that will be possible via the mechanism that you mentioned.

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:

- name: Checkout current ccpp-physics code
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Store remote-URL for current ccpp-physics code
run: echo "GIT_REMOTE_URL=`git remote get-url origin`" >> $GITHUB_ENV

- name: Store branch name for current ccpp-physics code
run: echo "GIT_REMOTE_BRANCH=`git rev-parse --abbrev-ref HEAD`" >> $GITHUB_ENV

- name: Store hash for HEAD of current ccpp-physics code
run: echo "GIT_REMOTE_HASH=`git rev-parse HEAD`" >> $GITHUB_ENV

- name: Checkout latest ccpp-physics code
run: git clone https://github.com/NCAR/ccpp-physics.git

- name: Initialize submodules
run: |
cd /home/runner/work/ccpp-physics/ccpp-physics/ccpp-physics
git submodule update --init --recursive

- name: Update ccpp-physics hash
if: github.event.pull_request == false
run: |
cd /home/runner/work/ccpp-physics/ccpp-physics/ccpp-physics/physics
echo $GIT_REMOTE_URL
echo $GIT_REMOTE_BRANCH
echo ${{github.repository}}
echo ${{ github.event.pull_request.head.sha }}
echo $GITHUB_SHA
git remote add remote_local $GIT_REMOTE_URL
git fetch remote_local $GIT_REMOTE_BRANCH
git checkout remote_local/$GIT_REMOTE_BRANCH


# - name: Set up and run Doxygen
# #uses: DenverCoder1/doxygen-github-pages-action@v2.0.0
# #with:
# # config_file: ./physics/docs/ccpp_doxyfile
# # folder: ./
# uses: mattnotmitt/doxygen-action@v1.12.0
# with:
# working-directory: '.'
# doxyfile-path: './physics/docs/ccpp_doxyfile'
# enable-latex: true

- name: Install Doxygen + Graphviz + LaTeX
run: |
sudo apt-get update
sudo apt-get install -y doxygen graphviz perl texlive-latex-base texlive-latex-extra texlive-fonts-recommended texlive-bibtex-extra

- name: Verify Perl installation
run: which perl

- name: Verify bibtex installation
run: which bibtex

- name: Verify Doxygen version
run: doxygen --version

- name: update doxyfile
run: |
cd physics/docs
doxygen -u ccpp_doxyfile

- name: Run Doxygen
run: |
cd physics/docs
doxygen ccpp_doxyfile

- name: Find html output
run: find . -type d -name html

- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: physics/docs/doc/html
- name: list files
run: ls -la physics/docs/doc/html/

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4.0.5

16 changes: 8 additions & 8 deletions physics/docs/ccpp_doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "CCPP SciDoc v7.0.0"
PROJECT_NAME = "CCPP SciDoc v7.0.x"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down Expand Up @@ -814,7 +814,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = ccpp_dox_layout.xml
LAYOUT_FILE = /home/runner/work/ccpp-physics/ccpp-physics/physics/docs/ccpp_dox_layout.xml

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand All @@ -824,7 +824,7 @@ LAYOUT_FILE = ccpp_dox_layout.xml
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.

CITE_BIB_FILES = library.bib
CITE_BIB_FILES = /home/runner/work/ccpp-physics/ccpp-physics/physics/docs/library.bib

# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH
# environment variable) so that external tools such as latex and gs can be
Expand All @@ -840,7 +840,7 @@ CITE_BIB_FILES = library.bib
# launching external tools will then become
# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin

EXTERNAL_TOOL_PATH =
EXTERNAL_TOOL_PATH = /usr/bin

#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
Expand Down Expand Up @@ -1127,7 +1127,7 @@ EXCLUDE_SYMBOLS =
# command).

EXAMPLE_PATH = pdftxt/RE7 \
doc/html
pdftxt

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
Expand Down Expand Up @@ -1173,7 +1173,7 @@ IMAGE_PATH = img
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by Doxygen.

INPUT_FILTER =
INPUT_FILTER =

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
Expand All @@ -1186,7 +1186,7 @@ INPUT_FILTER =
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by Doxygen.

FILTER_PATTERNS =
FILTER_PATTERNS =

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will also be used to filter the input files that are used for
Expand Down Expand Up @@ -2809,7 +2809,7 @@ INTERACTIVE_SVG = YES
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_PATH = /opt/homebrew/bin
DOT_PATH =

# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
Expand Down
6 changes: 3 additions & 3 deletions physics/docs/pdftxt/GFS_v16_suite.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ The GFS_v16 suite uses the parameterizations in the following order:
- \ref GFDL_cloud

\section sdf_gfsv16b Suite Definition File
\include suite_FV3_GFS_v16.xml
\include suite_SCM_GFS_v16.xml


\section gfs16_nml_opt_des Namelist
\ref GFDL_cloud namelist options
\snippet RE300/FV3_GFS_v16_input.nml GFDL_CLOUD_MICROPHYSICS_NML
\snippet RE7/input_GFS_v16.nml GFDL_CLOUD_MICROPHYSICS_NML
Other namelist options
\snippet RE300/FV3_GFS_v16_input.nml GFS_PHYSICS_NML
\snippet RE7/input_GFS_v16.nml GFS_PHYSICS_NML

- nstf_name = \f$[2,0,0,0,0]^1 [2,1,0,0,0]^2\f$
- \f$^1\f$ NSST is on and coupled with spin up off
Expand Down