fix(docs): mock rcl_interfaces to fix empty Node API page#1682
Draft
mjcarroll wants to merge 1 commit into
Draft
fix(docs): mock rcl_interfaces to fix empty Node API page#1682mjcarroll wants to merge 1 commit into
mjcarroll wants to merge 1 commit into
Conversation
Contributor
|
Tick the box to add this pull request to the merge queue (same as
|
Fixes: #1681 Assisted-by: Gemini CLI:Claude Sonnet 4.6 (Thinking) [gh, read_url_content, grep_search, run_command] Signed-off-by: Michael Carroll <mjcarroll.oss@gmail.com>
5ba50a1 to
4246b9b
Compare
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
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.
Description
Fixes the empty Node API docs page reported in #1681.
rclpy.nodeimportsrcl_interfaces.msgat module level, which transitively requiresrosidl_pycommon.interface_base_classes— unavailable in the Sphinx docs build environment. The import silently fails and autodoc renders a blank page. Addingautodoc_mock_imports = ['rcl_interfaces']toconf.pyunblocks the import without affecting the build.All other modules (
publisher,client, etc.) happen to avoid this because they don't importrcl_interfacesdirectly.Testing
Before this fix:
api/node.htmlcontains only<h1>Node</h1>— no class or method entries.After this fix:
Nodeclass with all ~124 methods is documented.To reproduce the failure, revert
conf.pyand rebuild.Did you use Generative AI?
Yes — Antigravity (Gemini CLI / Claude Sonnet 4.6) was used to diagnose the root cause and author the fix.