/moveit_tutorials

A sphinx-based centralized documentation repo for MoveIt!
  1. HTML 43.3%
  2. Python 36.8%
  3. JavaScript 14.8%
  4. CMake 3.8%
  5. CSS 1.2%
  6. Shell 0.1%
HTML Python JavaScript CMake CSS Shell

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit e6a016c Jul 5, 2017 @oliviao00 oliviao00 committed with v4hn Update setup_assistant_tutorial.rst (#82)
Permalink
Failed to load latest commit information.
_scripts Initial commit Aug 23, 2016
_static Right-align 'Edit on GitHub' button (#9) Aug 30, 2016
_themes/sphinx_rtd_theme [kinetic] Add a banner for code download instruction (similar to #69 … Mar 22, 2017
doc Update setup_assistant_tutorial.rst (#82) Jul 5, 2017
.gitignore Clang-formatted all tutorials (#43) Oct 31, 2016
.travis.yml Travis check errors (#28) Oct 18, 2016
CMakeLists.txt Revamp move_group_interface_tutorial Nov 1, 2016
README.md Added Trac-IK tutorial (#41) Oct 31, 2016
build_locally.sh Initial commit Aug 23, 2016
conf.py Revamp move_group_interface_tutorial Nov 1, 2016
index.rst New Tutorial on Time Parameterization / Speed Control (#50) Nov 14, 2016
package.xml Revamp move_group_interface_tutorial Nov 1, 2016
rosdoc.yaml Make compatible with older version of Sphinx (1.2.2) Aug 23, 2016

README.md

MoveIt! Tutorials

This repo is automatically built by the ROS build farm and its output is hosted here: http://docs.ros.org/kinetic/api/moveit_tutorials/html/

The tutorials use the reStructuredText format commonly used in the Sphinx "Python Documentation Generator". This unfortuantly differs from the common Markdown format.

Travis Continuous Integration

Build Status

ROS Buildfarm

Build Status

Versions

The indigo-devel branch should be considered for the most part "frozen" for historical reasons, and new changes to tutorials should be in the kinetic-devel branch.

Build

If you want to test the tutorials by generating the html pages locally on your machine, install rosdoc_lite:

sudo apt-get install ros-kinetic-rosdoc-lite

and run in the root of the package:

rosdoc_lite -o build .

Then open LOCAL_PACKAGE_PATH/build/html/index.html in your web browser.

Deployment

For deploying documentation changes to the web, Section 3 of 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.