Build documentation automatically using Travis CI

Author: elprans

.ci/push_key.enc

@@ -0,0 +1,73 @@
+#!/bin/bash
+
+# Based on https://gist.github.com/domenic/ec8b0fc8ab45f39403dd
+
+set -e -x
+
+SOURCE_BRANCH="master"
+TARGET_BRANCH="gh-pages"
+DOC_BUILD_DIR="_build/html/"
+
+if [ "${TRAVIS_OS_NAME}" != "linux" ]; then
+    echo "Skipping documentation build on non-linux."
+    exit 0
+fi
+
+pip install -r docs/requirements.txt
+make htmldocs
+
+if [ "${TRAVIS_PULL_REQUEST}" != "false" \
+        -o "${TRAVIS_BRANCH}" != "${SOURCE_BRANCH}" \
+        -o "${TRAVIS_OS_NAME}" != "linux" ]; then
+    echo "Skipping documentation deploy."
+    exit 0
+fi
+
+
+REPO=$(git config remote.origin.url)
+SSH_REPO=${REPO/https:\/\/github.com\//git@github.com:}
+COMMITISH=$(git rev-parse --verify HEAD)
+AUTHOR=$(git show --format="%aN <%aE>" "${COMMITISH}")
+
+git clone "${REPO}" docs/gh-pages
+cd docs/gh-pages
+git checkout "${TARGET_BRANCH}" || git checkout --orphan "${TARGET_BRANCH}"
+cd ..
+
+rm -r gh-pages/devel/
+rsync -a "${DOC_BUILD_DIR}/" gh-pages/devel/
+
+if [ -n "${TRAVIS_TAG}" ]; then
+    rm -r gh-pages/current/
+    rsync -a "${DOC_BUILD_DIR}/" gh-pages/current/
+fi
+
+cd gh-pages
+
+if git diff --quiet --exit-code; then
+    echo "No changes to documentation."
+    exit 0
+fi
+
+git add .
+git commit -m "Automatic documentation update" --author="${AUTHOR}"
+
+set +x
+echo "Decrypting push key..."
+ENCRYPTED_KEY_VAR="encrypted_${DOCS_PUSH_KEY_LABEL}_key"
+ENCRYPTED_IV_VAR="encrypted_${DOCS_PUSH_KEY_LABEL}_iv"
+ENCRYPTED_KEY=${!ENCRYPTED_KEY_VAR}
+ENCRYPTED_IV=${!ENCRYPTED_IV_VAR}
+openssl aes-256-cbc -K "${ENCRYPTED_KEY}" -iv "${ENCRYPTED_IV}" \
+            -in "${TRAVIS_BUILD_DIR}/.ci/push_key.enc" \
+            -out "${TRAVIS_BUILD_DIR}/.ci/push_key" -d
+set -x
+chmod 600 "${TRAVIS_BUILD_DIR}/.ci/push_key"
+eval `ssh-agent -s`
+ssh-add "${TRAVIS_BUILD_DIR}/.ci/push_key"
+
+git push "${SSH_REPO}" "${TARGET_BRANCH}"
+rm "${TRAVIS_BUILD_DIR}/.ci/push_key"
+
+cd "${TRAVIS_BUILD_DIR}"
+rm -rf docs/gh-pages

.ci/travis-build-docs.sh

@@ -13,6 +13,7 @@ env:
     global:
         - PYMODULE=asyncpg
         - PYPI_USER=magicstack-ci
+        - DOCS_PUSH_KEY_LABEL=0760b951e99c
         - secure: "XEUUpzRZeesmMUfImKbCJm1D1LmWXkCW6ywtquuLEp6vRboH+URW8XtOhPehj47kn+/D4LpS9DR7GTBQ2DJR6kb07uqMu4b3WhTj8gewc8T5A0bxbdkkxHDfUCw7RF+EYLoN+n8xdqgBHImLLeuY/iRf+/IUJxGBARC4OZkejXhqJktNkXNO7aDcFfl9jcU0s1azaGbgeaShSAnnQPcdnJQ5tn7qHPPjTMWWly09A0K6CGqFK9bXUlD/hLGyC6NjOc8zMhv6vt4rI/zkjtSf219t4svivTjZsWWP6LMoWNWvwbOVfr8MThU4449lfplTWkmvEP6cQAJrvLjBOKOfwvV1MhqCMLGUMxeagYq7bHwSKQQ7t+r4a3jX94go+3Y1AQ0z9Yun+UW4qxrmHeIR5tLh2cePQylkIiTaWePZNPsVl3xF9HJtWcVgNgij4r+EU6WC9EqlV4DJyISjsptSa69CLBieWrzPYNxCPr6cTXYKKu6svRj3uho2q+c3Iavzjt4e5VEgppeduXIrvqMsaAa/E+j7b3QmC0HfZ4k8U5J2evtell5gh70Vf20A9LsOF06m+I0mSDwrpGasSFCNrWH4n3cUDTlGzc93Zqw5eAmg0yYxLKWk1sHNLOB3hNn+NLSIkS6Drcrsya+Fp5k93I4qDIXvC9n7ODLMirAJ76o="
 
 matrix:
@@ -44,6 +45,7 @@ script:
     - if [ "$TRAVIS_OS_NAME" == "osx" ]; then eval "$(pyenv init -)"; fi
     - make && make test
     - make debug && make test
+    - .ci/travis-build-docs.sh
 
 before_deploy:
     - .ci/travis-build-and-upload.sh

.travis.yml

@@ -50,6 +50,10 @@ release: clean compile test
 	$(PYTHON) setup.py sdist upload
 
 
+htmldocs:
+	$(MAKE) -C docs html
+
+
 # Script to patch Cython 'async def' coroutines to have a 'tp_iter' slot,
 # which makes them compatible with 'yield from' without the
 # `asyncio.coroutine` decorator.

Makefile

@@ -18,7 +18,7 @@ Documentation
 -------------
 
 The project documentation can be found
-`here <https://magicstack.github.io/asyncpg/>`_.
+`here <https://magicstack.github.io/asyncpg/current/>`_.
 
 
 Performance