docs: doxygen support#25
Merged
Merged
Conversation
Closed
4 tasks
ripel2
suggested changes
Oct 13, 2024
This commit adds a new workflow file, deploy_doxygen_page.yml, which sets up the deployment of Doxygen documentation to GitHub Pages. The workflow is triggered on published releases. The workflow performs the following steps: - Checks out the repository - Installs Doxygen - Installs the Doxygen theme - Generates Doxygen documentation - Creates a .nojekyll file - Deploys the documentation to GitHub Pages using the peaceiris/actions-gh-pages action The Doxyfile.cfg file is also modified to update the OUTPUT_DIRECTORY to "docs/". Closes #25
ripel2
approved these changes
Oct 15, 2024
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
2 participants
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.
Add Doxygen support for our code and associated documentation
The Doxyfile is configured as:
Note:
Partially linked to: