Add nightly Python API docs workflow for Gazebo Python bindings - #709
Open
SomeshG1151 wants to merge 2 commits into
Open
Add nightly Python API docs workflow for Gazebo Python bindings#709SomeshG1151 wants to merge 2 commits into
SomeshG1151 wants to merge 2 commits into
Conversation
Adds a new CI workflow that builds Sphinx autodoc documentation
for Gazebo libraries with Python bindings, following the same
pattern as the existing nightly-upload.yml for Doxygen docs.
- nightly-python-docs.yml: builds and deploys Python API docs
- tools/build_python_docs.py: generates Sphinx HTML per distro
- tools/restructure_python_artifacts.py: restructures artifacts
for deployment to api/python/{lib}/{version}/
Prototype targets gz-math across harmonic, ionic, and jetty.
Closes gazebosim#663
SomeshG1151
marked this pull request as ready for review
August 14, 2026 23:33
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.
Closes #663
What this adds
.github/workflows/nightly-python-docs.yml— nightly CI that builds and deploys Python API docs, mirroring the existingnightly-upload.ymlpattern for Doxygentools/build_python_docs.py— generates Sphinx autodoc HTML for each distro/librarytools/restructure_python_artifacts.py— restructures build artifacts for deployment toapi/python/{lib}/{version}/Approach
Follows the same build → artifact → restructure → deploy pattern as the existing C++ Doxygen workflow. Prototype targets
gz-mathacross harmonic, ionic, and jetty. Can be expanded togz-msgs,gz-transport,sdformatonce this is validated.Notes
python3-gz-math*packages in the OSRF apt repo, so this was tested locally with Sphinx only. The workflow targets jammy/noble containers where the packages are available.furotheme for cleaner output; can be changed to match site style if preferred.