Develop - #6
Merged
Merged
Conversation
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.
This pull request adds automated Doxygen-based documentation generation and deployment to GitHub Pages. It introduces a new workflow for building and deploying docs, a Doxygen configuration file, and documentation on how to generate the docs locally and details about the automation.
Documentation automation and deployment:
.github/workflows/doxygen-pages.ymlto build HTML documentation with Doxygen and deploy it to GitHub Pages automatically on changes to documentation or source files.Doxygenconfiguration file at the repository root to specify how documentation is generated from Markdown and source code.Developer documentation:
docs/readme.mdwith instructions for generating documentation locally and an overview of the automated GitHub Actions workflow.