travis-ci setup

.travis.yml

@@ -0,0 +1,18 @@
+language: python
+python:
+  - '3.6'
+env:
+  matrix:
+    secure: m9erew3TlDT9DOS820wkCVwDVjo9IQNgDmU4r5rZMDowObfuaG/W42C6aphYBw/347GtfPPp7wg/Ler7aHHjv3yjY3GcepFaNkHVNbk+o1sLzFsR7gfTDl2J3wpOF5d4nfkJe37oHBgviCwlcLEq5NNmljdmi0vQpXDTFiLNzIhKeIWCJT2hXTegMqpyDzDNOxVjxrcRHGZppfGu/+FupRoAaqKSifareBNkbDB9w4yjsXxQg0AgMpmhtuy2lTl7bNRd7Sn90KzHZm9AuSXNxlcRv1e+EdogtssuEQpa9+n592GFlai7edVqxRD1XnD4tmAanQRGLDsc6YrhcunsgKRjUKfCPchAJi1177ImqQSN4sU5IwUwxBnWYpsuVukcj+D1RCwaw6Gw/D2mISgimCqZlvxAjqVqEnbaw1/M0/fMmOvgyIVTKFOZC8qG4jEgopzkXtevGx28xaWJKfKxdKeFN3l9HGAM+Q8hXwsU0UAsKqCkcABU9mbtRRN4xTQfj6Q7B2B7zh2lONcwjqbFZnzAd4xkdJ+NN9o/S8fgIgnYhA2UpoasMXEwhQaMIB2T+QJL3okOQLO6T6wd6yk0Wt1Js5WncM19T6Ju1lodzTkMkkmWnSFp24H3EV5R26MD0yAo3QgJIwHPx/iti7jKeiQi4Ekk4/6y1/sai+sA9Cw=
+install: 
+  - pip install -r requirements.txt
+script: 
+  - make deploy
+deploy:
+  provider: pages
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  keep-history: false
+  on:
+    branch: master
+  local_dir: _build/html

Makefile

@@ -15,7 +15,12 @@ help:
 .PHONY: help Makefile
 
 livehtml:
-	sphinx-autobuild -b html $(SOURCEDIR) $(BUILDDIR)/html
+	sphinx-autobuild --open-browser -b html "$(SOURCEDIR)" "$(BUILDDIR)"
+	
+deploy:
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" -nW
+	#  -n   Run in nit-picky mode. Currently, this generates warnings for all missing references.
+	#  -W   Turn warnings into errors that stop the build.
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

README.md

@@ -2,15 +2,15 @@
 
 Documentation for [OpenDroneMap](https://github.com/OpenDroneMap/OpenDroneMap).
 
-### Development
+## Development
+
+### Environment
 
 _(on OSX)_
 
 ```bash
 # install python
 brew install python3
-# check installation
-python --version
 # install virtualenv
 pip install virtualenv
 # create Python environment
@@ -26,7 +26,8 @@ Use [`sphinx-autobuild`](https://github.com/GaretJax/sphinx-autobuild) to automa
 ```
 make livehtml
 ```
-Go to the logged URL to access your site (e.g. `http://127.0.0.1:8000`).
+To stop the server press `Ctrl+C`.
-To stop the server simply press `Ctrl+C`.
 
+### Travis-CI
 
+Travis-CI docs for [Building a Python Project](https://docs.travis-ci.com/user/languages/python/) and [GitHub Pages Deployment](https://docs.travis-ci.com/user/deployment/pages/). Personal access token with 'public_repo - Access public repositories' permissions created and used it in `travis encrypt GH_TOKEN=my_github_token --add env.matrix` as described in the [Travis-CI docs](https://docs.travis-ci.com/user/environment-variables#Encrypting-environment-variables).

source/conf.py

@@ -30,6 +30,7 @@ release = '0.4'
 # ones.
 extensions = [
     'sphinx.ext.todo',
+    'sphinx.ext.githubpages'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

source/using.rst

@@ -334,7 +334,7 @@ If you supply a GCP file called gcp_list.txt then ODM will automatically detect
 
 For example, in this image, I would use the sharp corners of the diamond-shaped bioswales in the parking lot:
 
-.. image:: _static/tol_sm.jpg
+.. todo:: add file for ``.. image:: _static/tol_sm.jpg``
 
 You should also place/find the GCPs evenly around your survey area.