From d627420a1afc156eeaec3332c0589724b2476d68 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Thu, 8 Sep 2016 16:41:54 -0700 Subject: [PATCH 1/2] Updating readthedocs.org -> readthedocs.io links. Also removing CONTRIBUTING section about old docs-rtd tox environment. --- CONTRIBUTING.rst | 7 ------- README.rst | 2 +- docs/gcloud-auth.rst | 2 +- 3 files changed, 2 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b4a9f92fd98a..e3510b1a70e1 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 -------------------------------------------- diff --git a/README.rst b/README.rst index 24eab6391984..395a2483233e 100644 --- a/README.rst +++ b/README.rst @@ -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/gcloud-auth.html .. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication Google Cloud Datastore diff --git a/docs/gcloud-auth.rst b/docs/gcloud-auth.rst index 2b65a58c785f..809bdea54b8a 100644 --- a/docs/gcloud-auth.rst +++ b/docs/gcloud-auth.rst @@ -141,7 +141,7 @@ and factories are provided to create a :class:`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: From 4932a77a898d4a4306cc8597feb231a2c8d14ee8 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Thu, 8 Sep 2016 16:46:20 -0700 Subject: [PATCH 2/2] Renaming three RST docs with prefix gcloud->google-cloud. --- README.rst | 2 +- docs/bigtable-client-intro.rst | 2 +- docs/dns-usage.rst | 2 +- docs/error-reporting-usage.rst | 2 +- docs/{gcloud-api.rst => google-cloud-api.rst} | 0 docs/{gcloud-auth.rst => google-cloud-auth.rst} | 0 docs/{gcloud-config.rst => google-cloud-config.rst} | 2 +- docs/index.rst | 6 +++--- docs/language-usage.rst | 2 +- docs/logging-usage.rst | 2 +- docs/monitoring-usage.rst | 2 +- docs/vision-usage.rst | 2 +- google/cloud/credentials.py | 4 ++-- 13 files changed, 14 insertions(+), 14 deletions(-) rename docs/{gcloud-api.rst => google-cloud-api.rst} (100%) rename docs/{gcloud-auth.rst => google-cloud-auth.rst} (100%) rename docs/{gcloud-config.rst => google-cloud-config.rst} (96%) diff --git a/README.rst b/README.rst index 395a2483233e..6cd1c32dd030 100644 --- a/README.rst +++ b/README.rst @@ -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.io/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 diff --git a/docs/bigtable-client-intro.rst b/docs/bigtable-client-intro.rst index fa759481e8ba..2ec2fd1039e3 100644 --- a/docs/bigtable-client-intro.rst +++ b/docs/bigtable-client-intro.rst @@ -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 diff --git a/docs/dns-usage.rst b/docs/dns-usage.rst index d0f5415282fa..ce5dd24f0273 100644 --- a/docs/dns-usage.rst +++ b/docs/dns-usage.rst @@ -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 `. diff --git a/docs/error-reporting-usage.rst b/docs/error-reporting-usage.rst index c07c35a9070b..c746301fda30 100644 --- a/docs/error-reporting-usage.rst +++ b/docs/error-reporting-usage.rst @@ -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 diff --git a/docs/gcloud-api.rst b/docs/google-cloud-api.rst similarity index 100% rename from docs/gcloud-api.rst rename to docs/google-cloud-api.rst diff --git a/docs/gcloud-auth.rst b/docs/google-cloud-auth.rst similarity index 100% rename from docs/gcloud-auth.rst rename to docs/google-cloud-auth.rst diff --git a/docs/gcloud-config.rst b/docs/google-cloud-config.rst similarity index 96% rename from docs/gcloud-config.rst rename to docs/google-cloud-config.rst index 53132629cfcd..b30822522f76 100644 --- a/docs/gcloud-config.rst +++ b/docs/google-cloud-config.rst @@ -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 diff --git a/docs/index.rst b/docs/index.rst index edcf978c47f7..6fd7be753ef3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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:: diff --git a/docs/language-usage.rst b/docs/language-usage.rst index 9feea9c88de5..91292b24e0b0 100644 --- a/docs/language-usage.rst +++ b/docs/language-usage.rst @@ -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`. diff --git a/docs/logging-usage.rst b/docs/logging-usage.rst index 4736924eae04..57b583eb600c 100644 --- a/docs/logging-usage.rst +++ b/docs/logging-usage.rst @@ -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 diff --git a/docs/monitoring-usage.rst b/docs/monitoring-usage.rst index af217c6271f2..2b993de31448 100644 --- a/docs/monitoring-usage.rst +++ b/docs/monitoring-usage.rst @@ -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:: diff --git a/docs/vision-usage.rst b/docs/vision-usage.rst index 461ee9e19e27..e6f21a8b9d08 100644 --- a/docs/vision-usage.rst +++ b/docs/vision-usage.rst @@ -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 diff --git a/google/cloud/credentials.py b/google/cloud/credentials.py index 4861d43e3072..b6ca5f3aff04 100644 --- a/google/cloud/credentials.py +++ b/google/cloud/credentials.py @@ -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 '