Skip to content

Use label to link to specific action introspection sections #5565

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 6, 2025
Merged

Use label to link to specific action introspection sections #5565

merged 1 commit into from
May 6, 2025

Conversation

@christophebedard
Copy link
Member

@christophebedard christophebedard commented May 6, 2025

Follow-up to #5548, see #5548 (comment)

@christophebedard christophebedard mentioned this pull request May 6, 2025
Merged
@github-actions
Copy link

github-actions bot commented May 6, 2025

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/14870865126/artifacts/3074065663.

To view the resulting site:

  1. Click on the above link to download the artifacts archive
  2. Extract it
  3. Open html-artifacts-5565/index.html in your favorite browser

fujitatomoya
fujitatomoya approved these changes May 6, 2025
View reviewed changes
Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm 🚀 thanks for the patch, this is better to keep the reference in rst layer, instead of using html output after build.

we can backport this to kilted.

@fujitatomoya fujitatomoya merged commit f42056c into rolling May 6, 2025
5 checks passed
@fujitatomoya fujitatomoya deleted the christophebedard/ros2-action-echo-link-use-target branch May 6, 2025 22:43
@fujitatomoya fujitatomoya added the backport-kilted backport to kilted at reviewers discretion; from rolling to kilted label May 6, 2025
mergify bot pushed a commit that referenced this pull request May 6, 2025
@christophebedard @mergify
Use label to link to specific action introspection sections (#5565)
837f15f 
Signed-off-by: Christophe Bedard <[email protected]>
(cherry picked from commit f42056c)
@mergify mergify bot mentioned this pull request May 6, 2025
Merged
mergify bot pushed a commit that referenced this pull request May 6, 2025
@christophebedard @mergify
Use label to link to specific action introspection sections (#5565)
2b402e3 
Signed-off-by: Christophe Bedard <[email protected]>
(cherry picked from commit f42056c)

# Conflicts:
#	source/Releases/Release-Kilted-Kaiju.rst
#	source/Tutorials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
#	source/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Actions/Understanding-ROS2-Actions.rst
@mergify mergify bot mentioned this pull request May 6, 2025
Closed
mergify bot pushed a commit that referenced this pull request May 6, 2025
@christophebedard @mergify
Use label to link to specific action introspection sections (#5565)
0c30074 
Signed-off-by: Christophe Bedard <[email protected]>
(cherry picked from commit f42056c)

# Conflicts:
#	source/Releases/Release-Kilted-Kaiju.rst
#	source/Tutorials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
#	source/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Actions/Understanding-ROS2-Actions.rst
@mergify mergify bot mentioned this pull request May 6, 2025
Closed
@christophebedard
Copy link
Member Author

christophebedard commented May 6, 2025 •
edited
Loading

The fact that we can't backport this to other branches (this PR and #5548 (comment)) is an unfortunate limitation. We usually backport release notes to all branches, but like you said they don't necessarily have these newer articles/sections. What we do in some cases is use relative links that go up one level above the distro level and then go down to $distro/, like this:

ros2_documentation/source/Releases/Release-Kilted-Kaiju.rst

Line 45 in f42056c

`Install Kilted Kaiju <../../kilted/Installation.html>`__
.

But that limits us to (relative) .html links (since that goes "out" of the current Sphinx-built website), which this PR explicitly moves us away from 😅 it's not critical, but just something to keep in mind for future Sphinx-related improvements.

christophebedard added a commit that referenced this pull request May 6, 2025
@mergify @christophebedard
Use label to link to specific action introspection sections (#5565) (#…
2bf99f5 
…5567)

(cherry picked from commit f42056c)

Signed-off-by: Christophe Bedard <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fujitatomoya fujitatomoya fujitatomoya approved these changes

Assignees

No one assigned

Labels

backport-kilted backport to kilted at reviewers discretion; from rolling to kilted

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@christophebedard @fujitatomoya