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

Improve the documentation builds, including API docs #1275

Draft
wants to merge 33 commits into
base: main
Choose a base branch
from

Conversation

marchdf
Copy link
Contributor

@marchdf marchdf commented Oct 7, 2024

Summary

Improve the documentation builds, including API docs. Now we can build all the documentation with just

$ cd build && cmake -DAMR_WIND_ENABLE_DOCUMENTATION:BOOL=ON .. && cmake --build . -t docs

The API documentation, instead of being at a separate site and looking distinctly different, it is embedded in our usual sphinx documentation. Also update the doxyfile to a newer doxygen.

Before: 2 websites

First site

Screenshot 2024-10-07 at 1 03 53 PM

Second site

Screenshot 2024-10-07 at 1 04 17 PM

Now: 1 website with embedded API docs using a similar style.

Screenshot 2024-10-07 at 1 05 27 PM

Pull request type

Please check the type of change introduced:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

Checklist

The following is included:

  • new unit-test(s)
  • new regression test(s)
  • documentation for new capability

@marchdf
Copy link
Contributor Author

marchdf commented Oct 7, 2024

This apparently also makes us see all the doxygen warnings. So yay, I will fix that too.

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