Develop#38
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 introduces automated documentation generation and deployment using Doxygen and GitHub Pages, along with several improvements to documentation configuration and developer tooling. The most significant changes are the addition of a GitHub Actions workflow for building and deploying documentation, updates to the Doxygen configuration for improved output, and enhancements to developer container images to support documentation builds.
Documentation automation and deployment:
.github/workflows/doxygen-pages.yml) to automatically build and deploy Doxygen-generated documentation to GitHub Pages on changes to relevant files or on demand.Doxygen configuration improvements:
Doxygen, settingOUTPUT_DIRECTORYtodocs, updating input/output paths, and excluding build artifacts from documentation. [1] [2] [3] [4] [5]docs/readme.mdandREADME.mdto reflect the new documentation generation workflow and location. [1] [2]Developer environment support:
doxygento the list of installed packages in both.devcontainer/humble/Dockerfileand.devcontainer/jazzy/Dockerfileto allow building documentation inside development containers. [1] [2]