Refactor Doxygen configuration and enhance documentation#7
Merged
Conversation
Reorganise Doxygen settings in CMakeLists.txt for clarity and consistency. This change enhances the structure of the Doxygen configuration section.
Fixes a minor typo in the comment regarding C language optimisation for Doxygen documentation generation.
This change configures Doxygen to use README.md as the main page for the generated documentation, optimising the output for C language projects.
This change enables the use of MathJax for rendering mathematical formulas in the Doxygen-generated documentation, enhancing the presentation of technical content.
Modified the Doxygen configuration to exclude the test driver source file from the documentation generation. Updated the source directory path for Doxygen documentation and added a comment for clarity.
Standardise the code block syntax by removing spaces between the opening triple backticks and the language identifier throughout the README.md file.
Create a workflow to automate the generation and deployment of Doxygen documentation. The workflow includes steps for checking out the repository, installing dependencies, generating the documentation, and deploying it to GitHub Pages.
Updated the build target name from 'doxy' to 'Doxygen' in the GitHub Actions workflow for documentation generation.
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.
Improve the Doxygen configuration for better readability and structure. Set README.md as the main page for documentation and enable MathJax support for rendering mathematical formulas. Fix minor typos and standardise code block formatting in README.md to comply with Doxygen strictness.