Merged
Conversation
This commit introduces automated Doxygen HTML documentation generation.
Key changes:
- Added a `Doxyfile` to the root of the repository, configured to scan `src` and `include` directories and output HTML documentation to `docs/doxygen/html`.
- Modified the `.github/workflows/analysis.yml` workflow:
- Added a step to install Doxygen using `apt-get`.
- Added a step to run Doxygen using the `Doxyfile`.
- Added a step to upload the generated HTML documentation as a build artifact named `doxygen-html-docs`.
This will ensure that documentation is generated automatically with each run of the analysis workflow, providing up-to-date documentation for the project.
The previous version v3 was causing issues in the GitHub Actions workflow. Updated to v4 to resolve the action download error.
This commit addresses issues found during Doxygen generation: - Upgraded `Doxyfile` to version 1.9.8 using `doxygen -u` to remove obsolete tags and ensure compatibility. - Modified the `.github/workflows/analysis.yml` workflow to add a step that creates the `docs/doxygen` output directory before Doxygen is run. This resolves the "Output directory does not exist" error.
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.
No description provided.