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

README.md: update with link to doxygen documentation #1316

Merged

Conversation

MatthewMasarik-NOAA
Copy link
Collaborator

Pull Request Summary

Adds a link to the develop README.md for doxygen documentation.

Description

  • Provide a detailed description of what this PR does.
    • A link is added to the develop branch README.md, which points to the html doxygen generated webpages for WW3.
  • What bug does it fix, or what feature does it add?
    • N/A.
  • Is a change of answers expected from this PR?
    • No.

Please also include the following information:

  • Add any suggestions for a reviewer
  • Mention any labels that should be added:
    • documentation
  • Are answer changes expected from this PR? Please describe the changes and the reason why in addition to which of the following labels would apply: mod_def change, out_grd change, out_pnt change, restart file change, Regression test
    • N/A.

Issue(s) addressed

Commit Message

README.md: update with link to doxygen documentation

Check list

Testing

  • How were these changes tested?
    • N/A (documentation only).
  • Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
    • No code changes.
  • Have the matrix regression tests been run (if yes, please note HPC and compiler)?
    • N/A
  • Please indicate the expected changes in the regression test output, (Note the list of known non-identical tests.)
    • N/A
  • Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):
    • N/A

Copy link
Collaborator

@JessicaMeixner-NOAA JessicaMeixner-NOAA left a comment

Choose a reason for hiding this comment

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

Thanks for updating the readme @MatthewMasarik-NOAA and for the work towards doxygen!

@JessicaMeixner-NOAA
Copy link
Collaborator

No testing is done as this is just an update to the readme.

@JessicaMeixner-NOAA JessicaMeixner-NOAA merged commit 7705171 into NOAA-EMC:develop Nov 8, 2024
22 checks passed
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.

2 participants