Update documentation (#309)

urfeex · web-flow · commit ba00e69f5fb0 · 2025-04-24T09:03:02.000+02:00
- Add anchor to main page to be used by the assembled documentation
- Add github_url directives in order for the "Edit on GitHub" links to
work properly in the assembled documentation.
diff --git a/doc/architecture.rst b/doc/architecture.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture.rst
+
 Library architecture
 ====================
 
diff --git a/doc/architecture/dashboard_client.rst b/doc/architecture/dashboard_client.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/dashboard_client.rst
+
 .. _dashboard_client:
 
 DashboardClient
diff --git a/doc/architecture/instruction_executor.rst b/doc/architecture/instruction_executor.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/instruction_executor.rst
+
 .. _instruction_executor:
 
 Instruction Executor
diff --git a/doc/architecture/reverse_interface.rst b/doc/architecture/reverse_interface.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/reverse_interface.rst
+
 .. _reverse_interface:
 
 ReverseInterface
diff --git a/doc/architecture/rtde_client.rst b/doc/architecture/rtde_client.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/rtde_client.rst
+
 .. _rtde_client:
 
 RTDEClient
diff --git a/doc/architecture/script_command_interface.rst b/doc/architecture/script_command_interface.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/script_command_interface.rst
+
 .. _script_command_interface:
 
 Script Command Interface
diff --git a/doc/architecture/script_sender.rst b/doc/architecture/script_sender.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/script_sender.rst
+
 .. _script_sender:
 
 ScriptSender
diff --git a/doc/architecture/trajectory_point_interface.rst b/doc/architecture/trajectory_point_interface.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/trajectory_point_interface.rst
+
 .. _trajectory_point_interface:
 
 Trajectory Point Interface
diff --git a/doc/architecture/ur_driver.rst b/doc/architecture/ur_driver.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/ur_driver.rst
+
 .. _ur_driver:
 
 UrDriver
diff --git a/doc/examples.rst b/doc/examples.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/examples.rst
+
 Usage examples
 ==============
 
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,3 +1,7 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/index.rst
+
+.. _ur_client_library:
+
 ur_client_library
 =================
 
diff --git a/doc/installation.rst b/doc/installation.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/installation.rst
+
 Build / installation
 ====================
 
diff --git a/doc/polyscope_compatibility.rst b/doc/polyscope_compatibility.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/polyscope_compatibility.rst
+
 |polyscope| version compatibility
 =================================
 
diff --git a/doc/real_time.rst b/doc/real_time.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/real_time.rst
+
 .. _real time setup:
 
 Setup for real-time scheduling
diff --git a/doc/setup.rst b/doc/setup.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/setup.rst
+
 Setup a robot
 =============
 
diff --git a/doc/setup/network_setup.rst b/doc/setup/network_setup.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/setup/network_setup.rst
+
 .. _network_setup:
 
 Network setup
diff --git a/doc/setup/robot_setup.rst b/doc/setup/robot_setup.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/setup/robot_setup.rst
+
 .. _robot_setup:
 
 Robot setup
diff --git a/doc/setup/ursim_docker.rst b/doc/setup/ursim_docker.rst
@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/setup/ursim_docker.rst
+
 .. _ursim_docker:
 
 Setup URSim with Docker

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture.rst`
	`2`	`+`
`1`	`3`	`Library architecture`
`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_Client_Library/blob/master/doc/architecture/dashboard_client.rst`
	`2`	`+`
`1`	`3`	`.. _dashboard_client:`
`2`	`4`
`3`	`5`	`DashboardClient`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/instruction_executor.rst`
	`2`	`+`
`1`	`3`	`.. _instruction_executor:`
`2`	`4`
`3`	`5`	`Instruction Executor`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/reverse_interface.rst`
	`2`	`+`
`1`	`3`	`.. _reverse_interface:`
`2`	`4`
`3`	`5`	`ReverseInterface`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/rtde_client.rst`
	`2`	`+`
`1`	`3`	`.. _rtde_client:`
`2`	`4`
`3`	`5`	`RTDEClient`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/script_command_interface.rst`
	`2`	`+`
`1`	`3`	`.. _script_command_interface:`
`2`	`4`
`3`	`5`	`Script Command Interface`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/script_sender.rst`
	`2`	`+`
`1`	`3`	`.. _script_sender:`
`2`	`4`
`3`	`5`	`ScriptSender`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/trajectory_point_interface.rst`
	`2`	`+`
`1`	`3`	`.. _trajectory_point_interface:`
`2`	`4`
`3`	`5`	`Trajectory Point Interface`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/architecture/ur_driver.rst`
	`2`	`+`
`1`	`3`	`.. _ur_driver:`
`2`	`4`
`3`	`5`	`UrDriver`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:github_url: https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/doc/examples.rst`
	`2`	`+`
`1`	`3`	`Usage examples`
`2`	`4`	`==============`
`3`	`5`