[develop]: Turn on WARN_AS_ERROR for Doxygen Documentation Builds #1023
Conversation
This file contains 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
FernandoAndrade-NOAA
added
the
documentation
WenMeng-NOAA
added
enhancement
|
There is no need for conducting the UPP RTs with documentation updates in this PR. |
WenMeng-NOAA
added
the
No Baseline Change
|
This PR is ready for merging. |
DavidHuber-NOAA
added a commit
to DavidHuber-NOAA/UPP
that referenced
this pull request
Sep 9, 2024
* origin/develop: Updates to support MPAS applications (RRFS and HFIP) (NOAA-EMC#1029) Add 6-hrly max winds at 10m to SFS (NOAA-EMC#1019) Update jet.lua (NOAA-EMC#1027) Updates to support UPP use with MPAS (NOAA-EMC#1018) [develop]: Turn on WARN_AS_ERROR for Doxygen Documentation Builds (NOAA-EMC#1023) Sample PR for testing (NOAA-EMC#1007) Enable template 4-49 to obtain aerosol ensemble information (NOAA-EMC#1011) Relocate gfs/gefs/sfs control files (NOAA-EMC#990) update g2tmp on aws to 1.12.0 (NOAA-EMC#996) [develop]: Update requirements files (NOAA-EMC#994) Bump zipp from 3.17.0 to 3.19.1 in /doc/UserGuide (NOAA-EMC#991) remove stack-python load for Gaea build (NOAA-EMC#993) Bump certifi from 2024.2.2 to 2024.7.4 in /doc/UserGuide (NOAA-EMC#988) [develop]: Add Doxygen variable definitions to modules (NOAA-EMC#965) Read bucket either as an integer or float (NOAA-EMC#984) Update Orion module file for Rocky 9 upgrade (NOAA-EMC#987) UPP bugfixes for inline post and g2tmpl 1.12.0 compatibility (and number concentration updates) (NOAA-EMC#974) Sync the RRFS hotfix NOAA-EMC#967 and NOAA-EMC#968. (NOAA-EMC#979) Bump urllib3 from 2.2.1 to 2.2.2 in /doc/UserGuide (NOAA-EMC#981) Fix for hydrostatic runs - write out Omega and HGT from model output (NOAA-EMC#959) Bump requests from 2.31.0 to 2.32.0 in /doc/UserGuide (NOAA-EMC#963) Correct rt.sh paths (NOAA-EMC#957) Updates to use GRIB2 template 4.9 for QPFFFG and QPFARI variables in RRFS (NOAA-EMC#929) Add hourly averaged smoke PM2.5 and dust PM10 (NOAA-EMC#917) Update Namelist documentation for all namelist options (NOAA-EMC#940) update gtg code revision to v.4.16.3 (NOAA-EMC#954) Bump jinja2 from 3.1.3 to 3.1.4 in /doc/UserGuide (NOAA-EMC#953) Clean up labeling for 15-min accumulated fields (NOAA-EMC#948) Updates to the GSL exp1 ceiling diagnostic (NOAA-EMC#947) Additional RT log information (NOAA-EMC#941) add cmake load to modulefile/gaea.lua (NOAA-EMC#945) RRFS updates (NOAA-EMC#938) add module for AWS (NOAA-EMC#934)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR turns on the
WARN_AS_ERRORflag inDoxyfile.in, which will cause a build of the documentation to fail when there are warnings (e.g., due to missing/undocumented variables).It also enables the doc build in the CI to check that docs are building without warnings.
Resolves Issue #392 .
Documentation builds without warnings or errors on Hercules.