Switch back to Sphinx.

.travis.yml

@@ -12,7 +12,7 @@ script:
   - tox -e cover
   - tox -e system-tests
   - tox -e system-tests3
-  - tox -e docs
+  - scripts/update_docs.sh
 
 after_success:
   - tox -e coveralls

README.rst

@@ -11,7 +11,7 @@ Google Cloud Python Client
 -  `API Documentation`_
 
 .. _Homepage: https://googlecloudplatform.github.io/google-cloud-python/
-.. _API Documentation: http://googlecloudplatform.github.io/google-cloud-python/#/docs/master/google-cloud
+.. _API Documentation: http://googlecloudplatform.github.io/google-cloud-python/
 
 This client supports the following Google Cloud Platform services:
 

scripts/get_version.py

@@ -0,0 +1,19 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Simple script to get the google-cloud version."""
+
+from __future__ import print_function
+from pkg_resources import get_distribution
+print(get_distribution('google-cloud').version)

scripts/update_docs.sh

@@ -0,0 +1,89 @@
+#!/bin/bash
+
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -ev
+
+#########################################
+# Only update docs if we are on Travis. #
+#########################################
+if [[ "${TRAVIS_BRANCH}" == "master" ]] && \
+       [[ "${TRAVIS_PULL_REQUEST}" == "false" ]]; then
+  echo "Building new docs on a merged commit."
+elif [[ -n "${TRAVIS_TAG}" ]]; then
+  echo "Building new docs on a tag."
+else
+  echo "No docs to update for a new tag or merged commit on Travis."
+  echo "Verifying docs build successfully."
+  tox -e docs
+  exit
+fi
+
+# Adding GitHub pages branch. `git submodule add` checks it
+# out at HEAD.
+GH_PAGES_DIR="ghpages"
+git submodule add -q -b gh-pages \
+    "https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME}" \
+    ${GH_PAGES_DIR}
+
+# Determine if we are building a new tag or are building docs
+# for master. Then build new docset in docs/_build from master.
+if [[ -z "${TRAVIS_TAG}" ]]; then
+    SPHINX_RELEASE=$(git log -1 --pretty=%h) tox -e docs
+else
+    # Sphinx will use the package version by default.
+    tox -e docs
+fi
+
+# Get the current version. Assumes the PWD is the root of the git repo.
+# We run this after `tox -e docs` to make sure the `docs` env is
+# set up.
+CURRENT_VERSION=$(.tox/docs/bin/python scripts/get_version.py)
+
+# Update gh-pages with the created docs.
+cd ${GH_PAGES_DIR}
+if [[ -z "${TRAVIS_TAG}" ]]; then
+    git rm -fr latest/
+    cp -R ../docs/_build/html/ latest/
+else
+    if [[ -d ${CURRENT_VERSION} ]]; then
+        echo "The directory ${CURRENT_VERSION} already exists."
+        exit 1
+    fi
+    git rm -fr stable/
+    # Put the new release in stable and with the actual version.
+    cp -R ../docs/_build/html/ stable/
+    cp -R ../docs/_build/html/ "${CURRENT_VERSION}/"
+fi
+
+# Update the files push to gh-pages.
+git add .
+git status
+
+# H/T: https://github.com/dhermes
+if [[ -z "$(git status --porcelain)" ]]; then
+    echo "Nothing to commit. Exiting without pushing changes."
+    exit
+fi
+
+# Commit to gh-pages branch to apply changes.
+git config --global user.email "[email protected]"
+git config --global user.name "travis-ci"
+git commit -m "Update docs after merge to master."
+# NOTE: This may fail if two docs updates (on merges to master)
+#       happen in close proximity.
+git push -q \
+    "https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME}" \
+    HEAD:gh-pages