Add automated Doxygen documentation generation (#110)#114
Merged
jameslehoux merged 1 commit intoworkingfrom Mar 6, 2026
Merged
Add automated Doxygen documentation generation (#110)#114jameslehoux merged 1 commit intoworkingfrom
jameslehoux merged 1 commit intoworkingfrom
Conversation
Three new files implement CI-driven API documentation:
1. Doxyfile — Configured for the project with:
- SVG class hierarchy and include dependency graphs (Graphviz)
- Collaboration diagrams showing AMReX/HYPRE interfaces
- Directory dependency graphs
- Tree-view navigation with search
- All public APIs extracted from the doxygen comments
standardized in the previous commit
2. docs/mainpage.md — Landing page with:
- Architecture overview table (I/O, Physics, Fortran layers)
- Cross-referenced class listing (@ref links)
- Data flow diagram
3. .github/workflows/docs.yml — GitHub Actions workflow that:
- Triggers on pushes to master that touch src/, docs/, or Doxyfile
- Installs doxygen + graphviz on ubuntu-latest
- Builds HTML documentation
- Deploys to GitHub Pages via actions/deploy-pages@v4
- Supports manual dispatch via workflow_dispatch
Note: GitHub Pages must be configured to use "GitHub Actions" as the
source (Settings > Pages > Source) for the deployment to work.
https://claude.ai/code/session_01R6ttf92LsJvRQayiPi8xCw
Code Coverage ReportGenerated by CI — coverage data from gcovr |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three new files implement CI-driven API documentation:
Doxyfile — Configured for the project with:
docs/mainpage.md — Landing page with:
.github/workflows/docs.yml — GitHub Actions workflow that:
Note: GitHub Pages must be configured to use "GitHub Actions" as the source (Settings > Pages > Source) for the deployment to work.