-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Update python publisher tutorial with links to relevant docs #6181
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: rolling
Are you sure you want to change the base?
Update python publisher tutorial with links to relevant docs #6181
Conversation
fujitatomoya
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm with green CI.
|
@christophebedard can i have a second review on this? |
source/Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Py-Publisher-And-Subscriber.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Py-Publisher-And-Subscriber.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Py-Publisher-And-Subscriber.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Py-Publisher-And-Subscriber.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Py-Publisher-And-Subscriber.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Py-Publisher-And-Subscriber.rst
Outdated
Show resolved
Hide resolved
This PR is OK, but, similar to what was mentioned in #4985 (comment), I would not systematically do this for other articles. Instead of writing `Node <{package_link(rclpy)}api/node.html>`__ classeverywhere to link to the API docs for {api(rclpy, rclpy.Node)} classand expands it to the correct page. For now, I think we're still generally working on making sure API docs are properly generated, which does mean changes to rosdoc2, but it mostly means fixing a lot of the packages (e.g., ros2/geometry2#857). Then we can think about how to create/find tooling to easily link to it from here. Otherwise the page we link to may not exist or the actual URL may change shortly after. |
|
I can look up for developing/incorporating a proper system for links in a seperate issue. Or help with something that's WIP. Can this be taken care on the URL side? Maintaining a database of URL matched with the doc links? |
cd29132 to
0eaa779
Compare
0eaa779 to
419088d
Compare
christophebedard
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Last minor comment
source/Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Py-Publisher-And-Subscriber.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Py-Publisher-And-Subscriber.rst
Outdated
Show resolved
Hide resolved
I would hold off for now. Please see #6186 (comment) |
419088d to
c1baa5d
Compare
Description
Update python publisher and subscriber tutorial with links to relevant documentation.
Addresses #4985
Did you use Generative AI?
No.
Additional Information
This first PR is to test the idea. Also see that rosdep's link is explicitly set because the macro doesn't work, see #6180.