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

Shall I add doxygen to the build system? #289

Closed
edwardhartnett opened this issue Apr 20, 2021 · 4 comments · Fixed by #759
Closed

Shall I add doxygen to the build system? #289

edwardhartnett opened this issue Apr 20, 2021 · 4 comments · Fixed by #759
Labels
enhancement New feature or request

Comments

@edwardhartnett
Copy link
Collaborator

Shall I add doxygen to the build system, which would allow programmers to start using doxygen in the code?

@edwardhartnett edwardhartnett added the enhancement New feature or request label Apr 20, 2021
@junwang-noaa
Copy link
Collaborator

Yes, it is good to have it in the build system.

@edwardhartnett
Copy link
Collaborator Author

This is being held back by the lack of self-build capability in fv3atm. We can't do a doxygen build in CI if fv3atm cannot even be compiled successfully in CI.

@edwardhartnett
Copy link
Collaborator Author

I will close this issue until there is greater interest, and a fixed build system.

@edwardhartnett
Copy link
Collaborator Author

OK, interest in testing fv3atm has led to interest in documentation too.

The problems start because of the way we're lumping so many projects together using git submodules, rather than releasing them as separate libraries and then linking them in the usual way.

For example, the doc build of fv3atm will not work because both ccpp and upp include a "doc" target in their cmake files.

CMake Error at upp/docs/CMakeLists.txt:10 (add_custom_target):
  add_custom_target cannot create target "doc" because another target with
  the same name already exists.  The existing target is a custom target
  created in source directory
  "/home/runner/work/fv3atm/fv3atm/fv3atm/ccpp/framework/doc".  See
  documentation for policy CMP0002 for more details.


See https://github.com/edwardhartnett/fv3atm/actions/runs/7371629648/job/20059198642?pr=2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants