Sphinx Documentation and Deploymment #18
Merged
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.
Changelog
This pull request introduces a GitHub Actions workflow for automatically building and publishing Sphinx-based documentation. The workflow triggers on every push or pull request and ensures consistent generation and deployment of project documentation.
The documentation is built using Sphinx, with integration of Doxygen to extract inline documentation from C source code. The Doxygen output is then parsed and incorporated into the Sphinx build using the Breathe plugin, allowing seamless inclusion of API documentation within the overall project documentation.
The workflow supports multi-branch GitHub Pages, enabling documentation for different branches to be deployed side-by-side. This allows maintaining documentation for various development stages (e.g.,
main
, feature branches, and PR-specific previews). Each branch’s documentation is hosted under its respective path. For example:master
) is deployed to the root of the GitHub Pages site.(e.g. https://pulp-platform.github.io/chimera-sdk/)
(e.g. https://pulp-platform.github.io/chimera-sdk/branch/devel)
An example documentation for this branch can be previewed here.
Added
.github/workflows/docs.yml
.Changed
README.md
to avoid duplication and divergence.