Skip to content

Switching to readthedocs naming conventions. #1026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 4, 2015
Merged

Switching to readthedocs naming conventions. #1026

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Google Cloud Python Client
- `API Documentation`_

.. _Homepage: https://googlecloudplatform.github.io/gcloud-python/
.. _API Documentation: http://googlecloudplatform.github.io/gcloud-python/latest/
.. _API Documentation: http://googlecloudplatform.github.io/gcloud-python/stable/

This client supports the following Google Cloud Platform services:

Expand Down Expand Up @@ -55,7 +55,7 @@ consistency for all other queries.
See the ``gcloud-python`` API `datastore documentation`_ to learn how to
interact with the Cloud Datastore using this Client Library.

.. _datastore documentation: https://googlecloudplatform.github.io/gcloud-python/latest/datastore-api.html
.. _datastore documentation: https://googlecloudplatform.github.io/gcloud-python/stable/datastore-api.html

See the `official Google Cloud Datastore documentation`_ for more details on how
to activate Cloud Datastore for your project.
Expand Down Expand Up @@ -90,7 +90,7 @@ be used to distribute large data objects to users via direct download.
See the ``gcloud-python`` API `storage documentation`_ to learn how to connect
to Cloud Storage using this Client Library.

.. _storage documentation: https://googlecloudplatform.github.io/gcloud-python/latest/storage-api.html
.. _storage documentation: https://googlecloudplatform.github.io/gcloud-python/stable/storage-api.html

You need to create a Google Cloud Storage bucket to use this client library.
Follow along with the `official Google Cloud Storage documentation`_ to learn
Expand Down
10 changes: 5 additions & 5 deletions scripts/update_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,16 @@ 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 master/
cp -R ../docs/_build/html/ master/
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 latest/
# Put the new release in latest and with the actual version.
cp -R ../docs/_build/html/ latest/
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}/"

# Also update the versions file.
Expand Down
2 changes: 1 addition & 1 deletion scripts/versions.html.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ https://googlecloudplatform.github.io/gcloud-node" title="Node.js docs page">

</section><!-- end of .content -->
<nav class="side-nav">
<ul><li><a href="latest/index.html">Documentation</a></li></ul>
<ul><li><a href="stable/index.html">Documentation</a></li></ul>
<ul class="simple">
</ul>

Expand Down