automate deploying spec to gh-pages

Author: zetok

.travis.yml

@@ -22,3 +22,14 @@ script:
 branches:
   only:
     - master
+
+after_success:
+  - |
+    if [[ "$TRAVIS_PULL_REQUEST" == "false" ]] \
+        && [[ "$TRAVIS_BRANCH" == "master" ]]
+    then
+        mkdir www
+        cp rust.css www/
+        cp spec.html www/index.html
+        ./deploy-gh-pages.sh
+    fi

README.md

@@ -1,5 +1,29 @@
-# tox-spec
+# The Tox Reference [![Build Status](https://travis-ci.org/zetok/tox-spec.svg?branch=master)](https://travis-ci.org/zetok/tox-spec)
 
-[![Build Status](https://api.travis-ci.org/TokTok/tox-spec.svg)](https://travis-ci.org/TokTok/tox-spec)
+To generate HTML, you will need to get [Rust], since it provides `rustdoc` that
+does the job.
 
-Tox Protocol Specification
+To generate `spec.html`:
+
+```
+make spec.html
+```
+
+Aside from `spec.html` you will want to include `rust.css` to get a nice
+formatting of the spec.
+
+Alternatively, you can generate just a body part of the webpage using `Pandoc`:
+
+```
+make spec-pandoc.html
+```
+
+If you want to contribute, don't forget to make sure that text formatting is
+correct by running:
+
+```
+make format
+git diff
+```
+
+[Rust]: https://www.rust-lang.org

deploy-gh-pages.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# used in travis to deploy documentation to gh-pages branch
+
+(
+cd www
+git init
+git config user.name "Travis CI"
+git config user.email "[email protected]"
+git add .
+git commit --quiet -m "Deploy to GH pages."
+git push --force --quiet "https://${GH_TOKEN}@github.com/zetok/tox-spec.git" master:gh-pages &> /dev/null
+)