Skip to content

Commit

Permalink
Autoinstall rosdoc-lite if needed (#608)
Browse files Browse the repository at this point in the history
  • Loading branch information
davetcoleman authored Mar 11, 2021
1 parent cf8c525 commit 7215911
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,13 @@ This repository is currently built automatically by two systems. Travis builds t

## Build Locally

If you want to test the tutorials by generating the html pages locally on your machine, you will first need to install the `rosdoc_lite` package, and then you can use the ``build_locally`` script.
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:

> **_NOTE:_** [rosdoc_lite](https://wiki.ros.org/rosdoc_lite) is needed to run the build_locally.sh script!
export ROS_DISTRO=kinetic # 16.04
export ROS_DISTRO=melodic # 18.04
export ROS_DISTRO=noetic # 20.04

sudo apt install ros-$ROS_DISTRO-rosdoc-lite
source /opt/ros/$ROS_DISTRO/setup.bash
./build_locally.sh

Expand Down
6 changes: 5 additions & 1 deletion build_locally.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
#!/bin/sh

# Install rosdoc_lite if it isn't there yet
test -x `which rosdoc_lite` || sudo apt install ros-$ROS_DISTRO-rosdoc-lite
if ! command -v rosdoc_lite &> /dev/null
then
echo "Installing rosdoc_lite"
sudo apt install ros-$ROS_DISTRO-rosdoc-lite
fi

# Setup Environment
rm -rf build
Expand Down

0 comments on commit 7215911

Please sign in to comment.