• Stars
    star
    464
  • Rank 94,450 (Top 2 %)
  • Language
    HTML
  • License
    BSD 3-Clause "New...
  • Created about 8 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A sphinx-based centralized documentation repo for MoveIt

MoveIt Tutorials

MoveIt 1 Live tutorials

These are the tutorials for MoveIt 1, for MoveIt 2 see MoveIt 2 Tutorials

This is the primary documentation for the MoveIt project. We strongly encourage you to help improve MoveIt's documentation. Please consider reading the guidelines below for writing the best documentation and tutorials. However, if you are uncomfortable with any of the approaches, simply adding documentation text to your pull requests is better than nothing.

These tutorials use the reStructuredText format commonly used in the Sphinx "Python Documentation Generator". This unfortunately differs from the common Markdown format, but its advantage is that it supports embedding code directly from source files for inline code tutorials.

All content in this repository is open source and released under the BSD License v3. Each individual source code file should contain a copy of the license.

This repository is currently built automatically by two systems. Github Actions builds the documentation for Noetic, and ROS Build Farm builds the documentation for older versions:

Versions

  • indigo-devel usage is discouraged
  • kinetic-devel stable
  • melodic-devel stable
  • master latest, changes should target this branch

Build Locally

If you want to test the tutorials by generating the HTML pages locally on your machine, you can use the build_locally script. Run in the root of the moveit_tutorials package:

export ROS_DISTRO=kinetic # 16.04
export ROS_DISTRO=melodic # 18.04
export ROS_DISTRO=noetic  # 20.04

source /opt/ros/$ROS_DISTRO/setup.bash
./build_locally.sh

The local website <LOCAL_PACKAGE_PATH>/build/html/index.html should automatically open in your web browser.

ROS Build Farm Deployment

For deploying documentation changes to the web, Section 3 of the rosdoc_lite wiki says that "rosdoc_lite is automatically run for packages in repositories that have rosinstall files listed in the rosdistro repository." This is done about once every 24 hours, overnight.

Contributing

We rely on the community to keep these tutorials up-to-date and bug-free. If you find an issue with the tutorials please open an issue on GitHub or open a PR with the proposed changes.

Formatting and Style

Code Formatting

  • These tutorials use the same style guidelines as the MoveIt project. When modifying or adding to these tutorials, it is required that code is auto-formatted using clang-format. To check and apply the style guidelines we use pre-commit.
  • Tutorials should exemplify best coding practices. If a contribution wouldn't pass review in the MoveIt project, then it shouldn't pass review in the tutorials.
  • Relevant code should be included and explained using the .. tutorial-formatter:: tag.
  • Irrelevant code should be excluded from the generated HTML using the BEGIN_TUTORIAL, END_TUTORIAL, BEGIN_SUB_TUTORIAL, and END_SUB_TUTORIAL tags.
  • Whenever possible, links should be created using the extlinks dictionary defined in conf.py.
  • All demo code should be runnable from within the moveit_tutorials package.
  • Python code should be run using rosrun.

Style

  • Each tutorial should be focused on teaching the user one feature or interface within MoveIt.
  • Tutorials should flow from show to tell with videos and demos at the beginning followed by explanations.
  • New tutorials should match the formatting, style, and flow of existing tutorials whenever possible.

pre-commit

pre-commit is a tool that is used in moveit_tutorials to check and apply style guidelines automatically. To install pre-commit into your system:

pip3 install pre-commit

In your catkin workspace, under themoveit_tutorials directory you can install the git hooks like this:

cd $CATKIN_WS/src/moveit_tutorials && pre-commit install

With this pre-commit will automatically run and check a list of styling including clang-format, end of files, and trailing whitespaces whenever you run git commit. To run a pre-commit at any time other than git commit you can use the following command:

cd $CATKIN_WS/src/moveit_tutorials && pre-commit run -a

Directory Structure

  • Each tutorial should live in its own subdirectory within the ./doc/ <> directory.
  • Add your tutorial to index.rst in the root directory.
  • Tutorials should use the following directory structure omitting unnecessary files and subdirectories:
moveit_tutorials/doc/
└── <tutorial_name>/
    ├── <tutorial_name>_tutorial.rst
    ├── CMakeLists.txt
    ├── package.xml
    ├── setup.py
    ├── images/
    │   └── <tutorial_name>_<image_description>.png
    ├── include/
    │   └── <tutorial_name>/
    │       └── <include_header>.h                      # Any custom C++ library header files
    ├── launch/
    │   └── <tutorial_name>_tutorial.launch
    ├── src/
    │   ├── <tutorial_name>_tutorial.cpp                # Main C++ executable
    │   ├── <include_source>.cpp                        # Custom C++ library source files
    │   └── <tutorial_name>/
    │       ├── __init__.py
    │       ├── <tutorial_name>_tutorial.py             # Main Python executable
    │       └── <python_library>.py                     # Custom Python libraries
    └── test/                                           # Ideally tutorials have their own integration tests
        ├── <tutorial_name>_tutorial.test               # Launch file for tests
        ├── <tutorial_name>_tutorial_test.py            # Python tests for tutorial
        └── <tutorial_name>_tutorial_test.cpp           # C++ tests for tutorial

Including Images and Videos

Images

The standard way to include an image in reStructuredText is

.. image:: filename.png
   :width: 700px

This assumes that filename.png is in the same folder as the source .rst file. Images linked in this way will automatically be copied to the appropriate folder in the build.

External Documentation

Do not include animated gifs as the file format leads to very large files. Use a video format like webm and see the section on the local video below.

YouTube and other External Video

You can embed video with raw HTML, like in this example from the Pick and Place Tutorial.

.. raw:: html

    <div style="position: relative; padding-bottom: 5%; height: 0; overflow: hidden; max-width: 100%; height: auto;">
        <iframe width="700px" height="400px" src="https://www.youtube.com/embed/QBJPxx_63Bs?rel=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
    </div>

This includes Youtube's suggested embed code.

Local Video

To embed a video that is included in this repository, you also will use raw HTML, like this example from the Quickstart in RViz tutorial.

.. raw:: html

    <video width="700px" nocontrols="true" autoplay="true" loop="true">
        <source src="../../_static/rviz_joints_nullspace.webm" type="video/webm">
        The joints moving while the end effector stays still
    </video>

Note that the video file is in the _static folder instead of the same folder.

External Documentation on <video> tag

More Repositories

1

moveit

🤖 The MoveIt motion planning framework
C++
1,621
star
2

moveit2

🤖 MoveIt for ROS 2
C++
1,014
star
3

moveit_task_constructor

A hierarchical multi-stage manipulation planner
C++
172
star
4

moveit_visual_tools

Helper functions for displaying and debugging MoveIt! data in Rviz via published markers
C++
146
star
5

moveit2_tutorials

A sphinx-based centralized documentation repo for MoveIt 2
CSS
144
star
6

moveit_calibration

Hand-eye calibration tools for robot arms.
C++
124
star
7

panda_moveit_config

The Panda robot is the flagship MoveIt integration robot
CMake
99
star
8

moveit_grasps

Geometric grasping generator library for cuboids
C++
89
star
9

moveit_ros

THIS REPO HAS MOVED TO https://github.com/ros-planning/moveit
C++
69
star
10

moveit_resources

URDFs, meshes, and config packages for MoveIt testing
Python
61
star
11

geometric_shapes

Representation of geometric shapes
C++
57
star
12

moveit_pr2

MoveIt! Packages for PR2
C++
51
star
13

moveit_robots

MoveIt! configurations for different robots
C++
48
star
14

moveit_msgs

ROS messages used by MoveIt
CMake
46
star
15

moveit.ros.org

This is the MoveIt website
HTML
37
star
16

warehouse_ros

Data persistence for ROS using MongoDB
C++
31
star
17

moveit_core

THIS REPO HAS MOVED TO https://github.com/ros-planning/moveit
C++
30
star
18

moveit_example_apps

Demonstrator applications for using MoveIt with full robotic setups
Python
24
star
19

warehouse_ros_mongo

Implementation of warehouse_ros using MongoDB
C++
17
star
20

moveit_planners

THIS REPO HAS MOVED TO https://github.com/ros-planning/moveit
C++
16
star
21

moveit_ci

Continuous Integration for MoveIt
Shell
16
star
22

moveit_advanced

C++
15
star
23

moveit_drake

Experimental repository for Moveit2 - Drake integration
C++
15
star
24

warehouse_ros_sqlite

Data persistence for ROS using SQLite
C++
13
star
25

moveit_plugins

THIS REPO HAS MOVED TO https://github.com/ros-planning/moveit
C++
12
star
26

srdfdom

Semantic Robot Description Format
C++
12
star
27

moveit_ikfast

THIS REPO HAS MOVED TO https://github.com/ros-planning/moveit
C++
12
star
28

moveit_commander

THIS REPO HAS MOVED TO https://github.com/ros-planning/moveit
Python
11
star
29

moveit_kinematics_tests

DEPRECATED, MOVED TO https://github.com/ros-planning/moveit
C++
11
star
30

moveit_setup_assistant

THIS REPO HAS MOVED TO https://github.com/ros-planning/moveit
C++
8
star
31

random_numbers

Routines for random number generation
C++
8
star
32

moveit_docs

DEPRECATED - see https://github.com/ros-planning/moveit.ros.org
CSS
5
star
33

stomp_moveit

STOMP support for MoveIt - ROS 2
C++
4
star
34

moveit_metapackages

DEPRECATED - see https://github.com/ros-planning/moveit
CMake
2
star
35

moveit_experimental

THIS REPO HAS MOVED TO https://github.com/ros-planning/moveit
C++
1
star
36

moveit2_packages

1
star
37

moveit_benchmark_resources

Configurations and databases for setting up benchmarks with MoveIt
Python
1
star
38

moveit_visual_tools-release

1
star
39

py_binding_tools

Python binding tools for C++
C++
1
star