-
Notifications
You must be signed in to change notification settings - Fork 542
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
base: gh-pages
Are you sure you want to change the base?
Host doxygen html output on github pages #1286
Conversation
@edwardhartnett I listed you as a co-author from our conversations and your recommendations regarding this. please advise if you'd like anything changed |
Note: all CI build checks are expected to fail for this branch, since the source code is removed. |
Looks like .github/workflows/ needs to come out? https://matthewmasarik-noaa.github.io/WW3/ looks good. |
Ah! Thanks @AlexanderRichert-NOAA. I'll make that update. |
Workflows are removed, so now no failed CI. |
Processing paused: Temporary PR Policy. |
Pull Request Summary
Turn on
doxygen
html output hosting on Github Pages.Description
gh-pages
is introduced. This is the core of the PR.Doxygen.in
andEnableDoxygen.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 tagsfor 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.
https://NOAA-EMC.github.io/WW3
.Please also include the following information:
Issue(s) addressed
Commit Message
Host doxygen html output on github pages
Check list
Testing
N/A. New homepage displayed from
user_guide.md
.