Skip to content

Commit 548f3b7

Browse files
Felix ExnerVinDp
authored andcommitted
Added missing section about example driver
1 parent 8d90dc7 commit 548f3b7

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

doc/architecture.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ modules present in this library. Note that this is an incomplete view on the cla
1010

1111

1212
The core of this library is the ``UrDriver`` class which creates a
13-
fully functioning robot interface. For details on how to use it, please see the [Example
14-
driver](#example-driver) section.
13+
fully functioning robot interface. For details on how to use it, please see the
14+
:ref:`example-driver` section.
1515

1616
The ``UrDriver``'s modules will be explained in the following.
1717

doc/example.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _example-driver:
2+
3+
Example driver
4+
==============
5+
In the ``examples`` subfolder you will find a minimal example of a running driver. It starts an
6+
instance of the ``UrDriver`` class and prints the RTDE values read from the controller. To run it make
7+
sure to
8+
* have an instance of a robot controller / URSim running at the configured IP address (or adapt the
9+
address to your needs)
10+
* run it from the package's main folder (the one where this README.md file is stored), as for
11+
simplicity reasons it doesn't use any sophisticated method to locate the required files.

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ ur_client_library
88
installation
99
polyscope_compatibility
1010
architecture
11+
example
1112
real_time

0 commit comments

Comments
 (0)