Skip to content
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

Add html files for documentation generated in PR #965 #1006

Merged
merged 18 commits into from
Aug 14, 2024

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Jul 30, 2024

This PR adds the updated HTMLs for files updated in PR #965 to the gh-pages branch. Since gh-pages is a special branch w/o source code, the checks are expected to fail, and this does not indicate an error.

Although there are 715 files changed in this PR, almost all changes relate to metadata or file format (e.g., PNGs are now SVGs). The only content-related changes come from PR #965. Documentation has been regenerated from scratch (rather than just adding select files), since over time, differences in metadata have led to issues like #569 , where certain pages and links don't render properly. By regenerating the HTMLs in full, any incompatibilities should be resolved.

The Doxygen documentation with these updates can be viewed on the Doxygen page for my UPP fork: https://gspetro-noaa.github.io/UPP/.

@FernandoAndrade-NOAA FernandoAndrade-NOAA added the documentation Improvements or additions to documentation label Jul 30, 2024
@gspetro-NOAA gspetro-NOAA marked this pull request as ready for review July 30, 2024 21:49
@FernandoAndrade-NOAA FernandoAndrade-NOAA added the Ready for Review This PR is ready for code review. label Aug 7, 2024
@gspetro-NOAA
Copy link
Collaborator Author

@fossell @edwardhartnett -- Wen was wondering if either of you were available to review this gh-pages PR. It looks big but is mostly metadata changes from regenerating the docs with new Doxygen version. Hoping to automate the process soon, but in the meantime, it still needs a manual review.

@edwardhartnett
Copy link
Collaborator

Generally I don't use a PR to update the gh-pages branch, nor does it call for a review.

There is no code, only documentation output. Put it on the gh-pages branch from the command line, and inspect the result on the web.

@gspetro-NOAA
Copy link
Collaborator Author

@edwardhartnett Sounds reasonable! This process was inherited from our DTC counterparts, but it sounds like perhaps we should revise it. Will discuss with the CMs.

@FernandoAndrade-NOAA
Copy link
Collaborator

@WenMeng-NOAA Merging this PR. RTs will not be necessary for this update.

@FernandoAndrade-NOAA FernandoAndrade-NOAA merged commit 89fc538 into NOAA-EMC:gh-pages Aug 14, 2024
0 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Ready for Review This PR is ready for code review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants