Add Doxygen Github action for CCPP SciDoc display#1196
Add Doxygen Github action for CCPP SciDoc display#1196
Conversation
| push: | ||
| branches: | ||
| - main | ||
|
|
There was a problem hiding this comment.
Could you add workflow_dispatch: as a trigger so that this can be run via GitHub if necessary?
There was a problem hiding this comment.
@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).
grantfirl
left a comment
There was a problem hiding this comment.
Looks good. Consider adding the workflow_dispatch trigger.
|
@mzhangw Can you help explain what this version of SciDocs this is? It looks like you're using the main branch with the namelists/SDFs from V7.0.1? Is that correct? (i.e. I see you have it set as v7.0.x). |
|
@hertneky since this is based on the NCAR/ccpp-physics repository using SCM as host model, it could be considered the CCPP SCM SciDoc built on top of that repo (main). It is not intended for v7.0.1 at this time, but it should be straightforward to adapt it for that release if needed. For the HSD documentation, since those are intended for the ufs-weather-model, my thought is that we may need to implement a similar GitHub Action in the ufs-community/ccpp-physics repository as well. |
Should it be called main, then, in the document and not v7.0.x? I understand that the linked SDFs and namelists are old (from the v7.0.1 CCPP-SCM release?) which is the reason for my confusion. Sorry for all the questions. I am just trying to understand!
I think this makes sense, especially since the HSD namelists/SDFs live in the UWM repo. Happy to discuss further if needed. |
I think it may be overkill to have this action attached to both NCAR/main and ufs-community/ufs-dev. They don't differ much at any point in time. I'd suggest having this run either in NCAR/main or ufs-community/ufs-dev, whichever is better suited for your purposes, not both. |
|
I agree with Grant. The main issue is that each repository can host only
one website at the moment.
Regarding the SciDoc pages, we currently have several that need to be moved
off Mohawk: CCPP v7, SRWv3, and HSD. One possible solution is to create a
single main/landing page that serves as an introduction and hosts links to
CCPP-SCM v7, SRWv3, and HSD.
…On Fri, Feb 27, 2026 at 1:29 PM Grant Firl ***@***.***> wrote:
*grantfirl* left a comment (NCAR/ccpp-physics#1196)
<#1196 (comment)>
@hertneky <https://github.com/hertneky> since this is based on the
NCAR/ccpp-physics repository using SCM as host model, it could be
considered the CCPP SCM SciDoc built on top of that repo (main). It is not
intended for v7.0.1 at this time, but it should be straightforward to adapt
it for that release if needed.
For the HSD documentation, since those are intended for the
ufs-weather-model, my thought is that we may need to implement a similar
GitHub Action in the ufs-community/ccpp-physics repository as well.
@ligiabernardet <https://github.com/ligiabernardet>
I think it may be overkill to have this action attached to both NCAR/main
and ufs-community/ufs-dev. They don't differ much at any point in time. I'd
suggest having this run either in NCAR/main or ufs-community/ufs-dev,
whichever is better suited for your purposes, not both.
—
Reply to this email directly, view it on GitHub
<#1196 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AG7TW2T644WKCSZGWUGXJGT4OCSJ3AVCNFSM6AAAAACV5BIZ3SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTSNZUHE2DQNBVGM>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
The site is live at https://mzhangw.github.io/ccpp-physics/. After merged and with proper github pages setup, mzhangw will be replaced with NCAR.
@ligiabernardet
Description of Changes:
One or more paragraphs describing the problem, solution, and required changes.
Tests Conducted:
Explicitly state what tests were run on these changes, or if any are still pending (for README or other text-only changes, just put "None required". Make note of the compilers used, the platform/machine, and other relevant details as necessary. For more complicated changes, or those resulting in scientific changes, please be explicit!
OR Add any links to tests conducted. For example, "See ufs-community/ufs-weather-model#<pr_number>"
Dependencies:
Add any links to parent PRs (e.g. SCM and/or UFS PRs) or submodules (e.g. rte-rrtmgp). For example:
Documentation:
Does this PR add new capabilities that need to be documented or require modifications to the existing documentation? If so, brief supporting material can be provided here. Contact the CODEOWNERS if your PR requires extensive updates to the documentation. See https://github.com/NCAR/ccpp-doc for Technical Documentation or https://dtcenter.org/community-code/common-community-physics-package-ccpp/documentation for the latest Scientific Documentation.
Issue (optional):
If this PR is resolving or referencing one or more issues, in this repository or elewhere, list them here. For example, "Fixes issue mentioned in #123" or "Related to bug in NCAR/other_repository#123"
Contributors (optional):
If others have contributed to this work aside from the PR author, list them here