Skip to content

Add Doxygen Github action for CCPP SciDoc display#1196

Open
mzhangw wants to merge 78 commits intoNCAR:mainfrom
mzhangw:dox
Open

Add Doxygen Github action for CCPP SciDoc display#1196
mzhangw wants to merge 78 commits intoNCAR:mainfrom
mzhangw:dox

Conversation

@mzhangw
Copy link
Contributor

@mzhangw mzhangw commented Feb 23, 2026

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:

  • NCAR/ccpp-framework#<pr_number>
  • NOAA-EMC/ufsatm#<pr_number>
  • ufs-community/ufs-weather-model/#<pr_number>

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

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

@grantfirl grantfirl left a comment

Choose a reason for hiding this comment

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

Looks good. Consider adding the workflow_dispatch trigger.

@hertneky
Copy link
Collaborator

@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).
I think it would be useful to have docs for these branches:
main (develop)
release tags (e.g. v7.0.1)
HSD
Perhaps that's a different PR and is not intended for this PR?

@mzhangw
Copy link
Contributor Author

mzhangw commented Feb 27, 2026

@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

@hertneky
Copy link
Collaborator

hertneky commented Feb 27, 2026

@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.

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!

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.

I think this makes sense, especially since the HSD namelists/SDFs live in the UWM repo. Happy to discuss further if needed.

@grantfirl
Copy link
Collaborator

@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

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.

@mzhangw
Copy link
Contributor Author

mzhangw commented Feb 27, 2026 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants