Add github_url directives to all rst files (#1336)

urfeex · web-flow · commit d497de33da6e · 2025-04-11T13:48:14.000+02:00
This way the "Edit on GitHub" links in the assembled documentation work
correctly.
diff --git a/ur_calibration/doc/algorithm.rst b/ur_calibration/doc/algorithm.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_calibration/doc/algorithm.rst
+
 Calibration correction algorithm
 ================================
 
diff --git a/ur_calibration/doc/index.rst b/ur_calibration/doc/index.rst
@@ -1,3 +1,4 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_calibration/doc/index.rst
 
 ur_calibration
 ==============
diff --git a/ur_calibration/doc/usage.rst b/ur_calibration/doc/usage.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_calibration/doc/usage.rst
+
 Usage
 =====
 
diff --git a/ur_controllers/doc/index.rst b/ur_controllers/doc/index.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_controllers/doc/index.rst
+
 ur_controllers
 ==============
 
diff --git a/ur_moveit_config/doc/index.rst b/ur_moveit_config/doc/index.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_moveit_config/doc/index.rst
+
 .. _ur_moveit_config:
 
 ================
diff --git a/ur_moveit_config/doc/migration/jazzy.rst b/ur_moveit_config/doc/migration/jazzy.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_moveit_config/doc/migration/jazzy.rst
+
 ur_moveit_config
 ^^^^^^^^^^^^^^^^
 
diff --git a/ur_robot_driver/doc/controller_stopper.rst b/ur_robot_driver/doc/controller_stopper.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/controller_stopper.rst
+
 .. _controller_stopper:
 
 Controller stopper
diff --git a/ur_robot_driver/doc/dashboard_client.rst b/ur_robot_driver/doc/dashboard_client.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/dashboard_client.rst
+
 .. _dashboard_client_ros2:
 
 Dashboard client
diff --git a/ur_robot_driver/doc/features.rst b/ur_robot_driver/doc/features.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/features.rst
+
 .. role:: raw-html-m2r(raw)
    :format: html
 
diff --git a/ur_robot_driver/doc/hardware_interface_parameters.rst b/ur_robot_driver/doc/hardware_interface_parameters.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/hardware_interface_parameters.rst
+
 UR Hardware interface parameters
 ================================
 
diff --git a/ur_robot_driver/doc/index.rst b/ur_robot_driver/doc/index.rst
@@ -3,6 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root ``toctree`` directive.
 
+.. _ur_robot_driver:
+
 ur_robot_driver
 ===============
 
diff --git a/ur_robot_driver/doc/installation/installation.rst b/ur_robot_driver/doc/installation/installation.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/installation/installation.rst
+
 Installation of the ur_robot_driver
 ===================================
 
diff --git a/ur_robot_driver/doc/installation/robot_setup.rst b/ur_robot_driver/doc/installation/robot_setup.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/installation/robot_setup.rst
+
 Setting up a UR robot for ur_robot_driver
 =========================================
 
diff --git a/ur_robot_driver/doc/installation/toc.rst b/ur_robot_driver/doc/installation/toc.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/installation/toc.rst
+
 ############
 Installation
 ############
diff --git a/ur_robot_driver/doc/migration/jazzy.rst b/ur_robot_driver/doc/migration/jazzy.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/migration/jazzy.rst
+
 ur_robot_driver
 ^^^^^^^^^^^^^^^
 
diff --git a/ur_robot_driver/doc/operation_modes.rst b/ur_robot_driver/doc/operation_modes.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/operation_modes.rst
+
 .. _operation_modes:
 
 Operation modes
diff --git a/ur_robot_driver/doc/overview.rst b/ur_robot_driver/doc/overview.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/overview.rst
+
 Overview
 ========
 
diff --git a/ur_robot_driver/doc/robot_state_helper.rst b/ur_robot_driver/doc/robot_state_helper.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/robot_state_helper.rst
+
 .. _robot_state_helper:
 
 Robot state helper
diff --git a/ur_robot_driver/doc/setup_tool_communication.rst b/ur_robot_driver/doc/setup_tool_communication.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/setup_tool_communication.rst
+
 .. _setup-tool-communication:
 
 Setting up the tool communication on an e-Series robot
diff --git a/ur_robot_driver/doc/usage/controllers.rst b/ur_robot_driver/doc/usage/controllers.rst
@@ -1,5 +1,7 @@
 :github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/usage/controllers.rst
 
+.. _ur_controllers:
+
 Controllers
 ===========
 
diff --git a/ur_robot_driver/doc/usage/move.rst b/ur_robot_driver/doc/usage/move.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/usage/move.rst
+
 .. _move_the_robot:
 
 Move the robot
diff --git a/ur_robot_driver/doc/usage/script_code.rst b/ur_robot_driver/doc/usage/script_code.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/usage/script_code.rst
+
 Sending URScript code to the robot
 ==================================
 
diff --git a/ur_robot_driver/doc/usage/simulation.rst b/ur_robot_driver/doc/usage/simulation.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/usage/simulation.rst
+
 Simulation
 ==========
 
diff --git a/ur_robot_driver/doc/usage/startup.rst b/ur_robot_driver/doc/usage/startup.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/usage/startup.rst
+
 .. _ur_robot_driver_startup:
 
 Startup the driver
diff --git a/ur_robot_driver/doc/usage/toc.rst b/ur_robot_driver/doc/usage/toc.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/usage/toc.rst
+
 #####
 Usage
 #####

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_calibration/doc/algorithm.rst`
	`2`	`+`
`1`	`3`	`Calibration correction algorithm`
`2`	`4`	`================================`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_calibration/doc/index.rst`
`1`	`2`
`2`	`3`	`ur_calibration`
`3`	`4`	`==============`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_calibration/doc/usage.rst`
	`2`	`+`
`1`	`3`	`Usage`
`2`	`4`	`=====`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_controllers/doc/index.rst`
	`2`	`+`
`1`	`3`	`ur_controllers`
`2`	`4`	`==============`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_moveit_config/doc/index.rst`
	`2`	`+`
`1`	`3`	`.. _ur_moveit_config:`
`2`	`4`
`3`	`5`	`================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_moveit_config/doc/migration/jazzy.rst`
	`2`	`+`
`1`	`3`	`ur_moveit_config`
`2`	`4`	`^^^^^^^^^^^^^^^^`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/controller_stopper.rst`
	`2`	`+`
`1`	`3`	`.. _controller_stopper:`
`2`	`4`
`3`	`5`	`Controller stopper`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/dashboard_client.rst`
	`2`	`+`
`1`	`3`	`.. _dashboard_client_ros2:`
`2`	`4`
`3`	`5`	`Dashboard client`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/features.rst`
	`2`	`+`
`1`	`3`	`.. role:: raw-html-m2r(raw)`
`2`	`4`	`:format: html`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/doc/hardware_interface_parameters.rst`
	`2`	`+`
`1`	`3`	`UR Hardware interface parameters`
`2`	`4`	`================================`
`3`	`5`