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

doxygen build currently broken in CI runs #904

Open
edwardhartnett opened this issue Jan 8, 2025 · 1 comment · May be fixed by #906
Open

doxygen build currently broken in CI runs #904

edwardhartnett opened this issue Jan 8, 2025 · 1 comment · May be fixed by #906
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@edwardhartnett
Copy link
Collaborator

The CI runs are failing due to the doxygen build.

So WARN_AS_ERROR should not be turned on yet in the Doxyfile. I will fix.

[ 39%] Built target doxygen_doc
[ 40%] Generating API Documentation with Doxygen
warning: tag INPUT: input source '/home/runner/work/fv3atm/fv3atm/fv3atm/doc/user_guide.md' does not exist
warning: tag INPUT: input source '/home/runner/work/fv3atm/fv3atm/fv3atm/doc/2D-decomp.md' does not exist
warning: tag INPUT: input source '/home/runner/work/fv3atm/fv3atm/fv3atm/sorc/ncep_post.fd' does not exist
error: source '/home/runner/work/fv3atm/fv3atm/fv3atm/doc/user_guide.md' is not a readable file or directory... skipping.
 (warning treated as error, aborting now)

@edwardhartnett edwardhartnett added the documentation Improvements or additions to documentation label Jan 8, 2025
@edwardhartnett edwardhartnett self-assigned this Jan 8, 2025
@edwardhartnett
Copy link
Collaborator Author

OK, I have a fix for this, and it causes all the CI builds to pass, which is nice.

The problem happening above was because UPP had the same CMake ENABLE_DOCS option. So to get around that, I change the fv3atm option to ENABLE_FV3ATM_DOCS. Now the UPP documentation build is not involved and things work.

I will put up a PR.

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
Projects
Status: In progress
Development

Successfully merging a pull request may close this issue.

1 participant