Documentation fixes for tf2_kdl (backport #869)#873
Closed
mergify[bot] wants to merge 1 commit intojazzyfrom
Closed
Documentation fixes for tf2_kdl (backport #869)#873mergify[bot] wants to merge 1 commit intojazzyfrom
mergify[bot] wants to merge 1 commit intojazzyfrom
Conversation
Signed-off-by: R Kent James <kent@caspia.com> Signed-off-by: Alejandro Hernández Cordero <ahcorde@gmail.com> Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com> (cherry picked from commit e82e4fc) # Conflicts: # tf2_kdl/package.xml # tf2_kdl/rosdoc2.yaml
Contributor
Author
|
Cherry-pick of e82e4fc has failed: To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally |
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.
Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later
Description
This PR updates tf2_kdl so that the python API shows in rosdoc2. Issues fixed:
ament_python_install_packagein CMakeLists.txt to be found. Probably the cmake builds worked anyway since dependencies of tf2_kdl already installed ament_cmake_python, but rosdoc2 does not rely on such transitive dependencies.PyKDL. Adding this to <doc_depend> is needed to overcome this.docs/sourcewhich is a non-standard location. Documentation was moved to the supported locationdoc/source. Most of the stuff there was out of date, so the only thing that survived was conf.py which is identical to other conf.py in this repo. Content inmainpage.doxwas moved to the README instead.Is this user-facing behavior change?
Ideally no, it should only affect documentation.. In some forms of building, the missing buildtool_depend>ament_cmake_python</buildtool_depend> could have resulted previously in the python code not building at all, but that apparently did not actually occur. In any case I assume you wanted the python API to build, and have its documentation exposed, which is what this PR provides.
Did you use Generative AI?
See header.
This is an automatic backport of pull request #869 done by [Mergify](https://mergify.com).