Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moveit/moveit_tutorials
A sphinx-based centralized documentation repo for MoveIt
https://github.com/moveit/moveit_tutorials
Last synced: 4 days ago
JSON representation
A sphinx-based centralized documentation repo for MoveIt
- Host: GitHub
- URL: https://github.com/moveit/moveit_tutorials
- Owner: moveit
- License: bsd-3-clause
- Created: 2016-08-23T00:12:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-01T17:10:07.000Z (about 1 month ago)
- Last Synced: 2024-12-14T08:03:38.976Z (22 days ago)
- Language: HTML
- Homepage: https://moveit.github.io/moveit_tutorials/
- Size: 74.2 MB
- Stars: 488
- Watchers: 29
- Forks: 696
- Open Issues: 113
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# MoveIt Tutorials
[MoveIt 1 Live tutorials](https://moveit.github.io/moveit_tutorials/)
*These are the tutorials for MoveIt 1, for MoveIt 2 see [MoveIt 2 Tutorials](https://github.com/moveit/moveit2_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](http://www.sphinx-doc.org/en/stable/rest.html) 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](https://opensource.org/licenses/BSD-3-Clause). Each individual source code file should contain a copy of the license.
Github Actions builds and deploys the documentation for Noetic:
[](https://github.com/moveit/moveit_tutorials/actions/workflows/ci.yaml?query=branch%3Amaster) [](https://github.com/moveit/moveit_tutorials/actions/workflows/deploy.yaml?query=branch%3Amaster) [](https://github.com/moveit/moveit_tutorials/actions/workflows/format.yaml?query=branch%3Amaster)
## Versions
- [``indigo-devel``](http://docs.ros.org/indigo/api/moveit_tutorials/html/) usage is discouraged
- [``kinetic-devel``](http://docs.ros.org/kinetic/api/moveit_tutorials/html/) stable
- [``melodic-devel``](http://docs.ros.org/melodic/api/moveit_tutorials/html/) stable
- [``master``](https://moveit.github.io/moveit_tutorials/) latest, used for Noetic
## 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 ``/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](http://wiki.ros.org/rosdoc_lite) 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](http://wiki.ros.org/rosdistro/Tutorials/Indexing%20Your%20ROS%20Repository%20for%20Documentation%20Generation).
## 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](https://github.com/moveit/moveit_tutorials/issues/new) or open a PR with the proposed changes.
### Formatting and Style
**Code Formatting**
* These tutorials use the same [style guidelines](http://moveit.ros.org/documentation/contributing/code/) as the MoveIt project. When modifying or adding to these tutorials, it is required that code is auto-formatted using [clang-format](http://moveit.ros.org/documentation/contributing/code/). To check and apply the style guidelines we use [pre-commit](https://pre-commit.com/).
* 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 the``moveit_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.rst
├── CMakeLists.txt
├── package.xml
├── setup.py
├── images/
│ └── _.png
├── include/
│ └── /
│ └── .h # Any custom C++ library header files
├── launch/
│ └── _tutorial.launch
├── src/
│ ├── _tutorial.cpp # Main C++ executable
│ ├── .cpp # Custom C++ library source files
│ └── /
│ ├── __init__.py
│ ├── _tutorial.py # Main Python executable
│ └── .py # Custom Python libraries
└── test/ # Ideally tutorials have their own integration tests
├── _tutorial.test # Launch file for tests
├── _tutorial_test.py # Python tests for tutorial
└── _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](https://sublime-and-sphinx-guide.readthedocs.io/en/latest/images.html)
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
```
This includes [Youtube's suggested embed code](https://support.google.com/youtube/answer/171780?hl=en).
#### 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
The joints moving while the end effector stays still
```
Note that the video file is in the `_static` folder instead of the same folder.
[External Documentation on <video> tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video)