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

Host doxygen html output on github pages #1286

Open
wants to merge 5 commits into
base: gh-pages
Choose a base branch
from

Conversation

MatthewMasarik-NOAA
Copy link
Collaborator

@MatthewMasarik-NOAA MatthewMasarik-NOAA commented Aug 7, 2024

Pull Request Summary

Turn on doxygen html output hosting on Github Pages.

Description

  • Provide a detailed description of what this PR does.
    • Doxygen html documentation is hosted on github pages via:
      • The branch gh-pages is introduced. This is the core of the PR.
      • Doxygen.in and EnableDoxygen.cmake source path updates.
      • user_guide.md was added as main page.
      • ww3_doxy_tmpl.md was removed. This was originally intended to be a reference of the minimum tags
        for each Fortran construct, to provide some consistency. It was not intended to be a part of the doxygen output documentation. Given ~2/3 of the source code has been marked-down, and there are plenty of examples in the code now to reference, it seemed like a good time for cleanup as it having already served it's purpose.
      • The URL to the hosted documentation if merged: https://NOAA-EMC.github.io/WW3.
      • Note: a "beta" version was given. This will be the case until the remaining (~1/3) of source files have been marked-down. The updates will also be manual (CI to be introduced at a later date) during the beta period. To keeps tabs on (or better yet, contribute to!) progress for the remaining source files check: Add doxygen marked-down source #586.
  • Is a change of answers expected from this PR?
    • No. Only doxygen documentation related parts of the build system were changed.

Please also include the following information:

Issue(s) addressed

  • Please list any issues associated with this PR, including those the PR will fix/close. For example:

Commit Message

Host doxygen html output on github pages

Check list

Testing

  • How were these changes tested?
    • By building the doxygen html documentation, verifying correctness by displaying in a browser, verifying hosting on github pages from fork. See screenshot of output displayed in browser below.
  • Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
    • No testing for documentation.
  • 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. New homepage displayed from user_guide.md.
user_guide

@MatthewMasarik-NOAA
Copy link
Collaborator Author

@edwardhartnett I listed you as a co-author from our conversations and your recommendations regarding this. please advise if you'd like anything changed

@MatthewMasarik-NOAA
Copy link
Collaborator Author

Note: all CI build checks are expected to fail for this branch, since the source code is removed.

@AlexanderRichert-NOAA
Copy link
Contributor

Looks like .github/workflows/ needs to come out?

https://matthewmasarik-noaa.github.io/WW3/ looks good.

@MatthewMasarik-NOAA
Copy link
Collaborator Author

Looks like .github/workflows/ needs to come out?

Ah! Thanks @AlexanderRichert-NOAA. I'll make that update.

@MatthewMasarik-NOAA
Copy link
Collaborator Author

Workflows are removed, so now no failed CI.

@MatthewMasarik-NOAA
Copy link
Collaborator Author

Processing paused: Temporary PR Policy.

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