pydrake: Remove spurious documentation header dependencies #15068
Conversation
This file contains 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
jwnimmer-tri
added
priority: high
status: single reviewer ok
These were added in 6f37fd6 at a time when our pydrake linking was broken. We were linking the examples' libraries outside of libdrake.so, so their headers were not part of libdrake's headers, so for mkdoc to find them we needed to list them here individually. Now that we link the examples correctly (i.e., directly into libdrake.so), we no longer need to feed the redundant dependencies to mkdoc. As of bazel 4.1, the redundant headers actually break mkdoc, because we try to add these headers twice, with the second path spelling not matching any valid include path.
jwnimmer-tri
force-pushed
the
pydrake-examples-headers-docs
branch
from
ad9292a to
957b39b
Compare
There was a problem hiding this comment.
Reviewable status: LGTM missing from assignee SeanCurtis-TRI(platform) (waiting on @SeanCurtis-TRI)
There was a problem hiding this comment.
Reviewed 1 of 1 files at r1.
Reviewable status:complete! all discussions resolved, LGTM from assignee SeanCurtis-TRI(platform) (waiting on @jwnimmer-tri)
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.
These were added in #9603 at a time when our pydrake linking was broken. We were linking the examples' libraries outside of libdrake.so, so their headers were not part of libdrake's headers, so for mkdoc to find them we needed to list them here individually.
Now that we link the examples correctly (i.e., directly into libdrake.so; see #9826), we no longer need to feed the redundant dependencies to mkdoc.
As of Bazel 4.1.0, the redundant headers actually break mkdoc, because we try to add these headers twice, with the second path spelling not matching any valid include path.
This change is