Skip to content

Fix broken nav2 install-script link in the navigation section - #37

Merged
mmmarinho merged 1 commit into
mainfrom
fix-nav2-install-script-link
Sep 15, 2026
Merged

mmmarinho merged 1 commit into
mainfrom
fix-nav2-install-script-link

Conversation

@mmmarinho

Copy link
Copy Markdown
Owner

The navigation installation section (docs/source/navigation/installation.rst) included the nav2 install script from:

https://raw.githubusercontent.com/UoMMScRobotics/SFR_Gazebo/refs/heads/main/install_nav2.sh

which now returns 404 (so the section couldn't display/run the install commands, and the build emitted a Sphinx warning).

Fix

Point the include at the repository's own docker/gazebo_nav2/install_nav2.sh, mirroring exactly how the Gazebo section already references its sibling docker/gazebo_nav2/install_gazebo.sh:

-.. rli:: https://raw.githubusercontent.com/UoMMScRobotics/SFR_Gazebo/refs/heads/main/install_nav2.sh
+.. literalinclude:: ../../../docker/gazebo_nav2/install_nav2.sh
    :language: bash
    :lines: 5-14

The local file already contains the full apt-get install sequence the doc intends to show, so :lines: 5-14 is unchanged and the rendered output is preserved.

Verification

  • Full Sphinx build succeeds (exit 0).
  • The nav2 404 / SFR_Gazebo warning is gone; no SFR_Gazebo references remain in the built docs.
  • The rendered navigation page now shows the local script's ros-jazzy-navigation2 / ros-jazzy-nav2-bringup / ros-jazzy-nav2-minimal-tb* / ros-jazzy-slam-toolbox commands.

The navigation installation section pulled install_nav2.sh from
UoMMScRobotics/SFR_Gazebo, which now returns a 404. Point the
literalinclude at the repository's own docker/gazebo_nav2/install_nav2.sh,
mirroring how the Gazebo section references its install_gazebo.sh.

@mmmarinho mmmarinho left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

👍

@mmmarinho
mmmarinho merged commit c242d07 into main Sep 15, 2026
4 checks passed
@mmmarinho
mmmarinho deleted the fix-nav2-install-script-link branch September 15, 2026 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant