Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
@davetcoleman
davetcoleman committed Aug 23, 2016
1 parent c6b6202 commit 8add8cb
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,16 @@ This repo is automatically built by the ROS build farm and its output is hosted

## Build

To build locally for testing, run in root of repo:
If you want to test the tutorials by generating the html pages locally on your machine, install [rosdoc_lite](http://wiki.ros.org/rosdoc_lite):

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

and run in the root of the package:

rosdoc_lite -o build .

Then open ``/build/html/index.html`` in your web browser.
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](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).

0 comments on commit 8add8cb

Please sign in to comment.