Build the documentation

Documentation is built using readthedocs, using itself sphinx, and hosted on Everytime a push is made on github, a new build is triggered at


It uses reStructeredText instead of default markdown in order to support math equations, notes, warnings etc. More info at

Generate documentation locally

pip install -U --user pip sphinx sphinx-autobuild recommonmark sphinx_rtd_theme
  • Go to the docs directory : roscd rtt_lwr/../docs and type make livehtml.
  • Open your favorite webbrowser and go to to see the generated site locally.

Update the doc using your favorite text editor, like atom (, and open a pull request on github at