Skip to content

Commit

Permalink
Convert doc from markdown to rst
Browse files Browse the repository at this point in the history
  • Loading branch information
christophfroehlich committed Aug 1, 2023
1 parent 2288363 commit d8e7b91
Show file tree
Hide file tree
Showing 14 changed files with 549 additions and 465 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,34 @@ The following examples are part of this demo repository:
*RRBot* with an integrated sensor.


* Example 5: ["Industrial Robots with externally connected sensor"](example_5)
* Example 5: ["Industrial robots with externally connected sensor"](example_5)

*RRBot* with an externally connected sensor.

* Example 6: ["Modular Robots with separate communication to each actuator"](example_6)
* Example 6: ["Modular robots with separate communication to each actuator"](example_6)

The example shows how to implement robot hardware with separate communication to each actuator.

* Example 7: "Multi-robot example (tba.)"
* Example 7: ["6-DOF robot"](example_7)

A full tutorial for a 6 DOF robot for intermediate ROS 2 users.

* Example 8: ["Using transmissions"](example_8)

*RRBot* with an exposed transmission interface.

* Example 9: ["Gazebo Classic Simulation"](example_9)
* Example 9: ["Gazebo classic simulation"](example_9)

Demonstrates how to switch between simulation and hardware.

* Example 10: "RRbot with GPIO interfaces (tba.)"

* Example 11: "Car-like robot using steering controller library (tba.)"

* Example 12: "Controller chaining example (tba.)"

* Example 13: "Multi-robot example (tba.)"

## Getting started

The repository is structured into `example_XY` folders that fully contained packages with names `ros2_control_demos_example_XY`.
Expand Down
15 changes: 6 additions & 9 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,32 +41,28 @@ Example Overview
Example 1: RRBot
*RRBot* - or ''Revolute-Revolute Manipulator Robot'' - a simple position controlled robot with one hardware interface. This example also demonstrates the switching between different controllers.


Example 2: DiffBot
*DiffBot*, or ''Differential Mobile Robot'', is a simple mobile base with differential drive.
The robot is basically a box moving according to differential drive kinematics.


Example 3: "RRBot with multiple interfaces"
*RRBot* with multiple interfaces.


Example 4: "Industrial robot with integrated sensor"
*RRBot* with an integrated sensor.


Example 5: "Industrial Robots with externally connected sensor"
*RRBot* with an externally connected sensor.


Example 6: "Modular Robots with separate communication to each actuator"
The example shows how to implement robot hardware with separate communication to each actuator.

Example 7: "6-DOF robot"
A full tutorial for a 6 DOF robot for intermediate ROS 2 users.

Example 8: "Using transmissions"
*RRBot* with an exposed transmission interface.


Example 9: "Gazebo Classic"
Demonstrates how to switch between simulation and hardware.

Expand Down Expand Up @@ -252,7 +248,8 @@ Examples
Example 2: DiffBot <../example_2/doc/userdoc.rst>
Example 3: RRBot with multiple interfaces <../example_3/doc/userdoc.rst>
Example 4: Industrial robot with integrated sensor <../example_4/doc/userdoc.rst>
Example 5: Industrial Robots with externally connected sensor <../example_5/doc/userdoc.rst>
Example 6: Modular Robots with separate communication to each actuator <../example_6/doc/userdoc.rst>
Example 5: Industrial robots with externally connected sensor <../example_5/doc/userdoc.rst>
Example 6: Modular robots with separate communication to each actuator <../example_6/doc/userdoc.rst>
Example 7: 6DOF robot <../r6bot/doc/userdoc.rst>
Example 8: Using transmissions <../example_8/doc/userdoc.rst>
Example 9: Gazebo Classic <../example_9/doc/userdoc.rst>
Example 9: Gazebo classic <../example_9/doc/userdoc.rst>
455 changes: 3 additions & 452 deletions r6bot/README.md

Large diffs are not rendered by default.

File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
526 changes: 526 additions & 0 deletions r6bot/doc/userdoc.rst

Large diffs are not rendered by default.

0 comments on commit d8e7b91

Please sign in to comment.