Skip to content

Commit db17c5a

Browse files
committed
First draft of landing page
1 parent f28fd23 commit db17c5a

File tree

3 files changed

+20
-10
lines changed

3 files changed

+20
-10
lines changed

_static/images/ros2_driver.jpeg

79.4 KB
Loading

conf.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
# -- Project information -----------------------------------------------------
2121

22-
project = "Universal Robots ROS 2 Documentation"
22+
project = "Universal Robots ROS 2 Driver Documentation"
2323
copyright = "2024, Universal Robots A/S"
2424
author = "Universal Robots A/S"
2525

@@ -141,8 +141,8 @@
141141
latex_documents = [
142142
(
143143
master_doc,
144-
"ur_documentation.tex",
145-
"ur\\_documentation Documentation",
144+
"ur_ros2_driver_documentation.tex",
145+
"UR ROS 2 Driver Documentation",
146146
"Universal Robots A/S",
147147
"manual",
148148
),
@@ -153,7 +153,7 @@
153153

154154
# One entry per manual page. List of tuples
155155
# (source start file, name, description, authors, manual section).
156-
man_pages = [(master_doc, "ur_documentation", "ur_documentation Documentation", [author], 1)]
156+
man_pages = [(master_doc, "ur_ros2_driverdocumentation", "UR ROS 2 Driver Documentation", [author], 1)]
157157

158158

159159
# -- Options for Texinfo output ----------------------------------------------
@@ -164,7 +164,7 @@
164164
texinfo_documents = [
165165
(
166166
master_doc,
167-
"ur_documentation",
167+
"ur_ros2_driver_documentation",
168168
"ur_documentation Documentation",
169169
author,
170170
"ur_documentation",
@@ -203,7 +203,7 @@
203203
html_context = {
204204
"display_github": True,
205205
"github_user": "UniversalRobots",
206-
"github_repo": "Universal_Robots_ROS2_Documentation",
206+
"github_repo": "Universal_Robots_ROS_Documentation",
207207
"github_version": repos_file_branch + "/",
208208
"conf_py_path": "/",
209209
"source_suffix": source_suffix,
@@ -215,4 +215,4 @@
215215
'css/ur_theme.css',
216216
]
217217

218-
github_url = "https://github.com/UniversalRobots/Universal_Robots_ROS2_Documentation"
218+
github_url = "https://github.com/UniversalRobots/Universal_Robots_ROS_Documentation"

index.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,19 @@
33
Welcome to the Universal Robots ROS 2 driver documentation!
44
===========================================================
55

6-
This documentation covers the ROS 2 packages for Universal Robots robots and the standalone Universal Robots
7-
Client Library.
86

9-
Here comes some introduction to the ROS 2 driver. With images
7+
.. image:: _static/images/ros2_driver.jpeg
8+
:alt: UR ROS 2 driver
9+
:align: center
10+
:width: 80%
11+
12+
13+
This documentation covers everything around the ROS 2 driver packages for Universal Robots
14+
manipulators and the standalone Universal Robots Client Library.
15+
16+
With those packages it is possible to control a Universal Robots arm from an external application
17+
either directly using a C++ API (see :ref:`ur_client_library`) or using ROS 2 (see :ref:`ur_robot_driver`).
18+
1019

1120
.. note::
1221
There is also builtin ROS 2 support for PolyScope X robots, see the `PolyScope X ROS 2 documentation <https://docs.universal-robots.com/polyscopex-ros2/v10.7/index.html>`_ and / or :ref:`ros2_controller_vs_driver` for details.
@@ -27,3 +36,4 @@ Table of Contents
2736
Tutorial examples <doc/ur_tutorials/tutorial_index.rst>
2837
doc/migration_notes.rst
2938
doc/build_status
39+
doc/ros2_controller_vs_driver

0 commit comments

Comments
 (0)