-
Notifications
You must be signed in to change notification settings - Fork 166
Add Doxygen Github action for CCPP SciDoc display #1196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mzhangw
wants to merge
79
commits into
NCAR:main
Choose a base branch
from
mzhangw:dox
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
79 commits
Select commit
Hold shift + click to select a range
a0f17b5
add doxygen action
mzhangw 55af499
minor changes
mzhangw 1b04bbb
minor changes
mzhangw 5c382be
minor changes
mzhangw 14c12a2
doxy only
mzhangw 6e6251f
Create main.yml
mzhangw 88c42d8
Create jekyll-gh-pages.yml
mzhangw 3bc16e7
change
mzhangw e213b4f
add doxyfile into wkfl
mzhangw 173a0a2
Update doxygen.yml
mzhangw 639e095
Update doxygen.yml
mzhangw 65ff7c5
Update doxygen.yml
mzhangw 0153ff9
Update doxygen.yml
mzhangw 4eaf41c
Update doxygen.yml
mzhangw 0fb88e9
Update doxygen.yml
mzhangw 310afbf
Update doxygen.yml
mzhangw 7efd81d
Update doxygen.yml
mzhangw f926b72
Update doxygen.yml
mzhangw 94bb4aa
Update doxygen.yml
mzhangw 2d643c9
Update doxygen.yml
mzhangw 8d3cbea
Update doxygen.yml
mzhangw d706260
Update ccpp_doxyfile
mzhangw 86bfbf3
Update ccpp_doxyfile
mzhangw 41c0a24
update ccpp doxyfile
mzhangw f33cc26
Update doxygen.yml
mzhangw 00675dd
update doxyfile
mzhangw 4cc5c34
Merge branch 'dox' of https://github.com/mzhangw/ccpp-physics into dox
mzhangw a01a78c
Update doxygen.yml
mzhangw e16205e
Update doxygen.yml
mzhangw 9b66245
update doxyfile
mzhangw 53eef3b
Update doxygen.yml
mzhangw 6df1bb3
Update doxygen.yml
mzhangw 3d47ce1
Update doxygen.yml
mzhangw 1d07030
Update doxygen.yml
mzhangw 176fe1e
Update doxygen.yml
mzhangw 1faec18
Update doxygen.yml
mzhangw 7085923
Update doxygen.yml
mzhangw 6cb2d89
Update doxygen.yml
mzhangw 47194cc
Update doxygen.yml
mzhangw c72cd1c
Update doxygen.yml
mzhangw ecc2800
Update doxygen.yml
mzhangw fc5bce8
Update doxygen.yml
mzhangw 1c7c894
Update doxygen.yml
mzhangw b86f88d
Update doxygen.yml
mzhangw 1c4915c
Update doxygen.yml
mzhangw 215530d
Update doxygen.yml
mzhangw 172a54e
Update doxygen.yml
mzhangw 18ce313
Update doxygen.yml
mzhangw b28864c
Update doxygen.yml
mzhangw 1d8385c
Update doxygen.yml
mzhangw 33208f2
Update doxygen.yml
mzhangw 1d84e14
Update doxygen.yml
mzhangw d92218b
Update doxygen.yml
mzhangw eef0f52
Update doxygen.yml
mzhangw da49569
change path
mzhangw a3b4725
Merge branch 'dox' of https://github.com/mzhangw/ccpp-physics into dox
mzhangw ff53895
add mactex
mzhangw 117d82e
add mactex
mzhangw 213f61f
minor changes
mzhangw 724e40b
minor fix
mzhangw 40035aa
try1
mzhangw c8afcc5
try1
mzhangw 0095d8d
try2
mzhangw ecd6dcb
updates
mzhangw 594fbeb
update perl
mzhangw f408aa2
update perl
mzhangw bdc1673
update path
mzhangw f79ebeb
explicitly install
mzhangw fc55094
updates
mzhangw 20c1621
updates
mzhangw 8cee5bc
fix
mzhangw ef9ffa4
fix path
mzhangw 6b58aef
fix
mzhangw c2501d1
fix path
mzhangw 12ad2ba
fixes
mzhangw 84689f2
fix3
mzhangw 0368f65
cleanup
mzhangw 2e51931
restore yml files
mzhangw cd5ba76
Merge branch 'main' into dox
grantfirl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| name: Doxygen GitHub Pages Deploy Action | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| 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 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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.