fetchrobotics / docs

Robot User Manuals

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Fetch & Freight Research Edition Documentation

This is the source for the Fetch & Freight Research Edition Documentation, which is hosted at http://docs.fetchrobotics.com

Building New Releases

Install prerequisites:

sudo pip install sphinx

Build new release from master, store into gh-pages branch:

git checkout master
make html
make latexpdf
git checkout gh-pages && git pull
cp -r build/html/* .
cp build/latex/FetchRobotics.pdf .
rm -rf build
# Check for any new files created and add those manually
git commit -a -m "new build"
git push origin gh-pages

Troubleshooting:

If you get complaints about .sty files install the following

sudo apt-get install texlive-full

About

Robot User Manuals


Languages

Language:HTML 48.2%Language:Python 23.5%Language:Makefile 17.1%Language:JavaScript 10.7%Language:CSS 0.6%