ros2 / launch

Tools for launching multiple processes and for writing tests involving multiple processes.
Apache License 2.0
124 stars 139 forks source link

Fix sphinx directive to cross-ref Launch method #605

Closed aprotyas closed 2 years ago

aprotyas commented 2 years ago

This PR is required for a clean rosdoc2 build of launch_yaml and launch_xml.

:ref:meth: is not a valid Sphinx directive to cross-reference python methods. This has been replaced with :py:meth:, as suggested in the Sphinx documentation. Reference: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-meth

Signed-off-by: Abrar Rahman Protyasha aprotyas@u.rochester.edu

clalancette commented 2 years ago

Since this is just a change to documentation, I'm going to go ahead and merge this with just the Rpr job and without full CI. Thanks for the contribution!