Skip to content

Commit

Permalink
Merge pull request googleapis#2280 from dhermes/fix-rtd-links
Browse files Browse the repository at this point in the history
Updating RTD links and renaming RST docs with gcloud-* prefix
  • Loading branch information
dhermes authored Sep 9, 2016
2 parents a2afc69 + 4932a77 commit 52c5872
Show file tree
Hide file tree
Showing 14 changed files with 15 additions and 22 deletions.
7 changes: 0 additions & 7 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -310,13 +310,6 @@ can build the docs via::

$ tox -e docs

In addition, to build a preview of the `readthedocs`_ theme, you can
build via::

$ tox -e docs-rtd

.. _readthedocs: http://google-cloud-python.readthedocs.org/

Note About ``README`` as it pertains to PyPI
--------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Check out the `Authentication section`_ in our documentation to learn more.
You may also find the `authentication document`_ shared by all the
``google-cloud-*`` libraries to be helpful.

.. _Authentication section: http://google-cloud-python.readthedocs.org/en/latest/gcloud-auth.html
.. _Authentication section: http://google-cloud-python.readthedocs.io/en/latest/google-cloud-auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Google Cloud Datastore
Expand Down
2 changes: 1 addition & 1 deletion docs/bigtable-client-intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Configuration
-------------

- For an overview of authentication in ``google-cloud-python``,
see :doc:`gcloud-auth`.
see :doc:`google-cloud-auth`.

- In addition to any authentication configuration, you can also set the
:envvar:`GOOGLE_CLOUD_PROJECT` environment variable for the Google Cloud Console
Expand Down
2 changes: 1 addition & 1 deletion docs/dns-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Client
configure your DNS applications. Each instance holds both a ``project``
and an authenticated connection to the DNS service.

For an overview of authentication in ``google-cloud-python``, see :doc:`gcloud-auth`.
For an overview of authentication in ``google-cloud-python``, see :doc:`google-cloud-auth`.

Assuming your environment is set up as described in that document,
create an instance of :class:`Client <google.cloud.dns.client.Client>`.
Expand Down
2 changes: 1 addition & 1 deletion docs/error-reporting-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Authentication and Configuration
--------------------------------

- For an overview of authentication in ``google-cloud-python``,
see :doc:`gcloud-auth`.
see :doc:`google-cloud-auth`.

- In addition to any authentication configuration, you should also set the
:envvar:`GOOGLE_CLOUD_PROJECT` environment variable for the project you'd like
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/gcloud-auth.rst → docs/google-cloud-auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ and
factories are provided to create a :class:`Client <google.cloud.client.Client>` with
service account credentials.

.. _oauth2client: http://oauth2client.readthedocs.org/en/latest/
.. _oauth2client: http://oauth2client.readthedocs.io/en/latest/

For example, with a JSON keyfile:

Expand Down
2 changes: 1 addition & 1 deletion docs/gcloud-config.rst → docs/google-cloud-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Authentication
==============

The authentication credentials can be implicitly determined from the
environment or directly. See :doc:`gcloud-auth`.
environment or directly. See :doc:`google-cloud-auth`.

Logging in via ``gcloud beta auth application-default login`` will
automatically configure a JSON key file with your default project ID and
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
:hidden:
:caption: google-cloud

gcloud-api
gcloud-config
gcloud-auth
google-cloud-api
google-cloud-config
google-cloud-auth
operation-api

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion docs/language-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ means to configure your application. Each instance holds
an authenticated connection to the Natural Language service.

For an overview of authentication in ``google-cloud-python``, see
:doc:`gcloud-auth`.
:doc:`google-cloud-auth`.

Assuming your environment is set up as described in that document,
create an instance of :class:`~google.cloud.language.client.Client`.
Expand Down
2 changes: 1 addition & 1 deletion docs/logging-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Authentication and Configuration
--------------------------------

- For an overview of authentication in ``google-cloud-python``,
see :doc:`gcloud-auth`.
see :doc:`google-cloud-auth`.

- In addition to any authentication configuration, you should also set the
:envvar:`GOOGLE_CLOUD_PROJECT` environment variable for the project you'd like
Expand Down
2 changes: 1 addition & 1 deletion docs/monitoring-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ GCP projects and AWS accounts. It can also simply be the ID of
a monitored project.

Most often the authentication credentials will be determined
implicitly from your environment. See :doc:`gcloud-auth` for
implicitly from your environment. See :doc:`google-cloud-auth` for
more information.

It is thus typical to create a client object as follows::
Expand Down
2 changes: 1 addition & 1 deletion docs/vision-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Authentication and Configuration
--------------------------------

- For an overview of authentication in ``google-cloud-python``,
see :doc:`gcloud-auth`.
see :doc:`google-cloud-auth`.

- In addition to any authentication configuration, you should also set the
:envvar:`GOOGLE_CLOUD_PROJECT` environment variable for the project you'd like
Expand Down
4 changes: 2 additions & 2 deletions google/cloud/credentials.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ def _get_signed_query_params(credentials, expiration, string_to_sign):
signed payload.
"""
if not hasattr(credentials, 'sign_blob'):
auth_uri = ('http://gcloud-python.readthedocs.io/en/latest/'
'gcloud-auth.html#setting-up-a-service-account')
auth_uri = ('http://google-cloud-python.readthedocs.io/en/latest/'
'google-cloud-auth.html#setting-up-a-service-account')
raise AttributeError('you need a private key to sign credentials.'
'the credentials you are currently using %s '
'just contains a token. see %s for more '
Expand Down

0 comments on commit 52c5872

Please sign in to comment.