Merge pull request #45 from diydrones/vagrant

mrpollo · mrpollo · commit 4cb6d3fec98c · 2015-04-07T15:49:52.000-07:00
Vagrant for cross-platform doc builds
diff --git a/.gitignore b/.gitignore
@@ -3,5 +3,5 @@
 droneapi.egg-info
 dist
 build
+.vagrant
 *~
-
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ This package contains the python language bindings for the drone API and the ass
 
 ## Users wanted!
 
-We'd love your [feedback and suggestions](https://github.com/diydrones/dronekit-python/issues) about this API and are eager to evolve it to meet your needs.  
+We'd love your [feedback and suggestions](https://github.com/diydrones/dronekit-python/issues) about this API and are eager to evolve it to meet your needs.
 
 For documentation on how to use this API please see:
 
@@ -27,7 +27,6 @@ For documentation on how to use this API please see:
     * Advanced ['drone_delivery'](example/drone_delivery/)
     * Advanced ['follow-me'](example/follow_me/)
 
-	
 [Stack Overflow](http://stackoverflow.com/questions/tagged/dronekit-python) is the best place to ask for *technical support* on how to use the API.
 
-Copyright 2014 3D Robotics, Inc. - Licensed under the Apache 2.0 License.
+Copyright 2014 3D Robotics, Inc. - Licensed under the Apache 2.0 License.
diff --git a/Vagrantfile b/Vagrantfile
@@ -0,0 +1,25 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure(2) do |config|
+    config.vm.box = "ubuntu/trusty64"
+
+    config.vm.provision "shell", inline: <<-SHELL
+        apt-get -y update
+        echo "[DroneKit]: Installing build essentials"
+        apt-get -y install build-essential
+        echo "[DroneKit]: Installing Python Devel"
+        apt-get -y install python-dev
+        echo "[DroneKit]: Installing pip ..."
+        apt-get -y install python-pip
+        easy_install -U pip
+        echo "[DroneKit]: Installing Sphinx ... "
+        pip install sphinx
+        cd /vagrant
+        echo "[DroneKit]: Installing DroneKit-Python requirements.txt ... "
+        pip install -r requirements.txt
+        echo "[DroneKit]: Building docs "
+        cd docs/
+        make html
+    SHELL
+end
diff --git a/docs/automodule.rst b/docs/automodule.rst
@@ -1,3 +1,4 @@
+=============================
 DroneKit-Python API Reference
 =============================
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,7 +17,7 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../droneapi'))
+sys.path.append(os.path.abspath('..'))
 
 # -- General configuration -----------------------------------------------------
 
diff --git a/docs/example_1.rst b/docs/example_1.rst
@@ -1,10 +1,11 @@
+========================
 First Demo: Simple Go To
 ========================
 
 This little demonstration just tells the vehicle to fly to a couple of different locations in the world.  You can edit the code to pick a latitude and longitude close to your position.
 
 Running the example
--------------------
+===================
 
 Once Mavproxy is running and the API is loaded, you can run this small example by typing: ``api start simple_goto.py``
 
@@ -20,7 +21,7 @@ It will tell your vehicle to start flying to a particular latitude and longitude
 
 
 How does it work?
------------------
+=================
 
 The key code in this demo is the following:
 
diff --git a/docs/example_2.rst b/docs/example_2.rst
@@ -1,3 +1,4 @@
+===========================
 Second Demo: Drone Delivery
 ===========================
 
@@ -10,7 +11,7 @@ New functionality demonstrated by this example includes:
 
 
 Starting the demo
-------------------
+=================
 
 The demonstration is started similar to the previous tutorials.  You should see output that looks like the following:
 
@@ -34,7 +35,7 @@ The demonstration is started similar to the previous tutorials.  You should see
 	GPS lock at 0 meters
 
 Screenshots
------------
+===========
 
 You should be able to reach your new webserver at http://localhost:8080. It will look like the following:
 
@@ -46,10 +47,10 @@ You should be able to reach your new webserver at http://localhost:8080. It will
 
 
 Looking at the code
--------------------
+===================
 
 Using attribute observers
-~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------
 
 All attributes in DroneKit can have observers - this is the primary mechanism you should use to be notified of changes in vehicle state.  For instance, `drone_delivery.py <https://github.com/diydrones/droneapi-python/blob/master/example/drone_delivery/drone_delivery.py>`_ calls:
 
@@ -71,7 +72,7 @@ All attributes in DroneKit can have observers - this is the primary mechanism yo
 This results in DroneKit calling our ``location_callback`` method any time the location attribute gets changed.
 
 Starting CherryPy from a DroneKit application
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------------------------
 
 We start running a web server by calling ``cherrypy.engine.start()``.
 
diff --git a/docs/example_3.rst b/docs/example_3.rst
@@ -1,11 +1,12 @@
+=========================
 Third Demo: Flight Replay
 =========================
 
 This is an interesting demo that uses our web API to query raw flight data from a particular flight.
 
 
 Starting the demo
------------------
+=================
 
 In this case, we pick some public flight from `Droneshare <http://www.droneshare.com/>`_:
 
@@ -37,10 +38,10 @@ One possible use of some variant of this tool to replay your old flights at your
 
 
 How it works
-------------
+============
 
 Getting the points
-~~~~~~~~~~~~~~~~~~
+------------------
 
 The following simple function asks for the droneshare flight data:
 
@@ -60,7 +61,7 @@ Some comments:
 
 
 Setting the new waypoints
--------------------------
+=========================
 
 We generate up to 100 wpts for the vehicle with the following code:
 
diff --git a/docs/example_4.rst b/docs/example_4.rst
@@ -1,3 +1,4 @@
+======================
 Fourth Demo: Follow Me
 ======================
 
diff --git a/docs/first_app.rst b/docs/first_app.rst
@@ -1,5 +1,7 @@
+====================
 Running the Examples
-===============
+====================
+
 
 With your drone connected via SITL or USB, you can verify the DroneKit installation by running the example apps that come with the source of DroneKit Python.
 
@@ -16,36 +18,36 @@ Let's run a small example app to verify our connection with the drone:
 
 
 Starting MAVProxy
-------------------
+=================
 
 When developing new DroneAPI python code the easiest approach is to run it inside of MAVProxy. 
 
 So launch MAVProxy with the correct options for talking to your vehicle:
 
 Linux computer connected to the vehicle via USB
-~~~~~~~~~~~~~~~~~~
+-----------------------------------------------
 
 ::
 
     mavproxy.py --master=/dev/ttyUSB0
 
 SITL Linux connected to the vehicle via UDP
-~~~~~~~~~~~~~~~~~~
+-------------------------------------------
 
 ::
 
     mavproxy.py
 
 OSX computer connected to the vehicle via USB
-~~~~~~~~~~~~~~~~~~
+---------------------------------------------
 
 ::
 
     mavproxy.py --master=/dev/cu.usbmodem1
 
 
 Windows computer connected to the vehicle via USB
-~~~~~~~~~~~~~~~~~~
+-------------------------------------------------
 
 ::
 
@@ -55,7 +57,7 @@ Windows computer connected to the vehicle via USB
 For other connection options see the `MAVProxy documentation <http://tridge.github.io/MAVProxy/>`_.
 
 Loading DroneKit
-------------------
+================
 
 The API includes a mavproxy module to allow you to load (and reload) your custom application into mavproxy.
 
@@ -74,7 +76,7 @@ We recommend adding this line to the mavproxy startup script in ~/.mavinit.scr.
     echo "module load droneapi.module.api" >> ~/.mavinit.scr
 
 Running the example
-------------------
+===================
 
 The first example we will run is a very small application that just reads some vehicle state and then changes the vehicle mode to AUTO (to start following prestored waypoints).
 
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -1,43 +1,47 @@
+===============
 Getting Started
 ===============
 
-On-board apps for drones typically run on a Linux-based "companion computer" that communicates with the autopilot via a serial port.  However, you may find it easier to first prototype your app on a standard Mac, Windows, or Linux 
+On-board apps for drones typically run on a Linux-based "companion computer" that communicates with the autopilot via a serial port.  However, you may find it easier to first prototype your app on a standard Mac, Windows, or Linux
 computer using a simulated autopilot, a process called "Software in the Loop Simulation" (SITL). This document will show you how to do both of these.
 
+
 Supported Companion Computers
------------------------------
+=============================
+
 
 RaspberryPi
-~~~~~~~~~~~
+-----------
+
 * `Communicating with Raspberry Pi via MAVLink <http://dev.ardupilot.com/wiki/companion-computers/raspberry-pi-via-mavlink/>`_
 * `Making a Mavlink WiFi bridge using the Raspberry Pi <http://dev.ardupilot.com/wiki/companion-computers/raspberry-pi-via-mavlink/making-a-mavlink-wifi-bridge-using-the-raspberry-pi/>`_
 
 Intel Edison
-~~~~~~~~~~~~
+------------
+
 * `Edison for drones <http://dev.ardupilot.com/wiki/companion-computers/edison-for-drones/>`_
 
 BeagleBoneBlack
-~~~~~~~~~~~~~~~~
+---------------
+
 * `BeaglePilot <http://dev.ardupilot.com/wiki/companion-computers/beaglepilot/>`_
 
 Odroid
-~~~~~~
+------
 * `Communicating with ODroid via MAVLink <http://dev.ardupilot.com/wiki/companion-computers/odroid-via-mavlink/>`_
 * `ODroid Wifi Access Point for sharing files via Samba <http://dev.ardupilot.com/wiki/companion-computers/odroid-via-mavlink/odroid-wifi-access-point-for-sharing-files-via-samba/>`_
 
 
-
-
 Installing DroneKit
--------------------
+===================
 
 If you are using a virtual vehicle to prototype, it is recommended that you install DroneKit on that virtual environment where you are running SITL.
 
 If you are planning to run DroneKit on an onboard computer, make sure that the onboard computer run a variant of Linux that support Python and can install Python packages from the internet.
 
 
 Linux dependencies
-~~~~~~~~~~~~~~~~~~
+------------------
 
 If you are running Ubuntu or Debian Linux you can get all the DroneKit dependencies by running:
 
@@ -47,7 +51,7 @@ If you are running Ubuntu or Debian Linux you can get all the DroneKit dependenc
 
 
 OSX dependencies
-~~~~~~~~~~~~~~~~
+----------------
 
 If you're on Mac OSX, you can use `Homebrew <http://brew.sh/>`_ to install WXMac.
 
@@ -69,7 +73,7 @@ On OSX you need to uninstall python-dateutil since osx comes bundled with a vers
 
 
 Windows dependencies
-~~~~~~~~~~~~~~~~~~~~
+--------------------
 
 The windows installation is a little more involved, but not too hard.
 
@@ -91,9 +95,9 @@ Open the folder where you installed WinPython, run "*WinPython Control Panel*" a
 	pip install droneapi
 
 Install MAVProxy
-~~~~~~~~~~~~~~~~
+----------------
 
-When developing new DroneKit Python code the easiest approach is to run it inside of MAVProxy, a lightweight CLI tool to send MAVLink messages. Learn more about MAVProxy `here <http://tridge.github.io/MAVProxy/>`_. 
+When developing new DroneKit Python code the easiest approach is to run it inside of MAVProxy, a lightweight CLI tool to send MAVLink messages. Learn more about MAVProxy `here <http://tridge.github.io/MAVProxy/>`_.
 
 Install MAVProxy with the following command:
 
@@ -103,7 +107,7 @@ Install MAVProxy with the following command:
 
 
 Set up DroneKit
-~~~~~~~~~~~~~~~
+---------------
 
 The DroneKit library is available on the public pypi repository. You can use the PyPi tool to install.
 
@@ -112,25 +116,24 @@ The DroneKit library is available on the public pypi repository. You can use the
     pip install droneapi
 
 
-
 Set up a simulated vehicle
---------------------------
+==========================
 The best way to prototype apps for drones is to use a simulated vehicle. APM provides a Software-In-The-Loop (SITL) environment, which simulates a copter or plane, in Linux.
 
 If you want to test your app in real life, you should also grab a ready to fly copter from the  `3D Robotics Store <http://store.3drobotics.com>`_.
 
 
 
 Dependencies
-~~~~~~~~~~~~
+------------
 
-If you are using Mac OSX or Windows, you need to set up a virtual Linux machine to run SITL. 
+If you are using Mac OSX or Windows, you need to set up a virtual Linux machine to run SITL.
 
 A popular virtual machine manager for running SITL is `Virtual Box <https://www.virtualbox.org/>`_. A virtual machine running Ubuntu Linux 13.04 or later works great.
 
 
 Set up SITL on Linux
-~~~~~~~~~~~~~~~~~~~~
+--------------------
 
 Please see `instructions here <http://dev.ardupilot.com/wiki/setting-up-sitl-on-linux/>`_ to set up SITL on Ubuntu.
 
@@ -144,4 +147,3 @@ Once you have the simulated vehicle running, enter the following commands. (You
     STABILIZE>param load ../Tools/autotest/copter_params.parm
     STABILIZE>param set ARMING_CHECK 0
 
-Congrats! You've set up DroneKit and a simulator on your computer. Next we'll look at running your first app.
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,6 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+===========================================
 Welcome to DroneKit-Python's documentation!
 ===========================================
 
diff --git a/droneapi/lib/__init__.py b/droneapi/lib/__init__.py
diff --git a/requirements.txt b/requirements.txt

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+=============================`
`1`	`2`	`DroneKit-Python API Reference`
`2`	`3`	`=============================`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+======================`
`1`	`2`	`Fourth Demo: Follow Me`
`2`	`3`	`======================`
`3`	`4`