Skip to content

Commit

Permalink
Fixing references to "dead" docs links. (googleapis#3631)
Browse files Browse the repository at this point in the history
* Fixing references to "dead" docs links.

Done via:

$ git grep -l 'google-cloud-auth.html' | \
> xargs sed -i s/'google-cloud-auth.html'/'core\/auth.html'/g
$ git grep -l 'http\:\/\/google-cloud-python.readthedocs.io' | \
> xargs sed -i s/'http\:\/\/google-cloud-python.readthedocs.io'/\
> 'https\:\/\/google-cloud-python.readthedocs.io'/g

Fixes googleapis#3531.

* Fixing up other docs that were moved in googleapis#3459.
  • Loading branch information
dhermes authored and landrito committed Aug 22, 2017
1 parent b23e5d6 commit c6107a3
Show file tree
Hide file tree
Showing 20 changed files with 39 additions and 43 deletions.
4 changes: 2 additions & 2 deletions bigquery/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down Expand Up @@ -86,7 +86,7 @@ Perform a synchronous query
See the ``google-cloud-python`` API `BigQuery documentation`_ to learn how
to connect to BigQuery using this Client Library.

.. _BigQuery documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/bigquery-usage.html
.. _BigQuery documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/bigquery/usage.html

.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigquery.svg
:target: https://pypi.python.org/pypi/google-cloud-bigquery
Expand Down
4 changes: 2 additions & 2 deletions bigtable/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Google Cloud Bigtable

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/bigtable-usage.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/bigtable/usage.html

Quick Start
-----------
Expand All @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down
2 changes: 1 addition & 1 deletion core/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ used by all of the ``google-cloud-*``.

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/google-cloud-api.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/core/modules.html

Quick Start
-----------
Expand Down
2 changes: 1 addition & 1 deletion core/google/cloud/credentials.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def _get_signed_query_params(credentials, expiration, string_to_sign):
signed payload.
"""
if not isinstance(credentials, google.auth.credentials.Signing):
auth_uri = ('http://google-cloud-python.readthedocs.io/en/latest/'
auth_uri = ('https://google-cloud-python.readthedocs.io/en/latest/'
'core/auth.html?highlight=authentication#setting-up-'
'a-service-account')
raise AttributeError('you need a private key to sign credentials.'
Expand Down
6 changes: 3 additions & 3 deletions datastore/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Google Cloud Datastore

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/datastore-client.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/datastore/client.html

Quick Start
-----------
Expand All @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand All @@ -44,7 +44,7 @@ queries, and eventual consistency for all other queries.
See the ``google-cloud-python`` API `datastore documentation`_ to learn how to
interact with the Cloud Datastore using this Client Library.

.. _datastore documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/datastore-client.html
.. _datastore documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/datastore/client.html

See the `official Google Cloud Datastore documentation`_ for more details on
how to activate Cloud Datastore for your project.
Expand Down
4 changes: 2 additions & 2 deletions dns/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Google Cloud DNS

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/dns-usage.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/dns/usage.html

Quick Start
-----------
Expand All @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down
4 changes: 2 additions & 2 deletions error_reporting/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Stackdriver Error Reporting

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/error-reporting-usage.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/error-reporting/usage.html

Quick Start
-----------
Expand All @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down
4 changes: 2 additions & 2 deletions language/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Google Cloud Natural Language

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/language-usage.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/language/usage.html

Quick Start
-----------
Expand All @@ -28,7 +28,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down
6 changes: 3 additions & 3 deletions logging/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Stackdriver Logging

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/logging-usage.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/logging/usage.html

Quick Start
-----------
Expand All @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down Expand Up @@ -54,7 +54,7 @@ Example of fetching entries:
See the ``google-cloud-python`` API `logging documentation`_ to learn how to
connect to Stackdriver Logging using this Client Library.

.. _logging documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/logging-usage.html
.. _logging documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/logging/usage.html

.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-logging.svg
:target: https://pypi.python.org/pypi/google-cloud-logging
Expand Down
6 changes: 3 additions & 3 deletions monitoring/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Stackdriver Monitoring

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/monitoring-usage.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/monitoring/usage.html

Quick Start
-----------
Expand All @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down Expand Up @@ -64,7 +64,7 @@ Display CPU utilization across your GCE instances during the last five minutes:
See the ``google-cloud-python`` API `monitoring documentation`_ to learn how
to connect to Stackdriver Monitoring using this Client Library.

.. _monitoring documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/monitoring-usage.html
.. _monitoring documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/monitoring/usage.html

.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-monitoring.svg
:target: https://pypi.python.org/pypi/google-cloud-monitoring
Expand Down
6 changes: 3 additions & 3 deletions pubsub/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Google Cloud Pub / Sub

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/pubsub-usage.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/pubsub/usage.html

Quick Start
-----------
Expand All @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand All @@ -45,7 +45,7 @@ independently written applications.
See the ``google-cloud-python`` API `Pub/Sub documentation`_ to learn how to connect
to Cloud Pub/Sub using this Client Library.

.. _Pub/Sub documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/pubsub-usage.html
.. _Pub/Sub documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/pubsub/usage.html

To get started with this API, you'll need to create

Expand Down
6 changes: 3 additions & 3 deletions resource_manager/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Google Cloud Resource Manager

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/resource-manager-api.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/resource-manager/api.html

Quick Start
-----------
Expand All @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand All @@ -42,7 +42,7 @@ Google Cloud Platform.
See the ``google-cloud-python`` API `Resource Manager documentation`_ to learn
how to manage projects using this Client Library.

.. _Resource Manager documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/resource-manager-api.html
.. _Resource Manager documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/resource-manager/api.html

.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-resource-manager.svg
:target: https://pypi.python.org/pypi/google-cloud-resource-manager
Expand Down
2 changes: 1 addition & 1 deletion runtimeconfig/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down
2 changes: 1 addition & 1 deletion spanner/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Python Client for Cloud Spanner

Python idiomatic client for `Cloud Spanner`_.

.. _Cloud Spanner: https://googlecloudplatform.github.io/google-cloud-python/latest/spanner-usage.html
.. _Cloud Spanner: https://googlecloudplatform.github.io/google-cloud-python/latest/spanner/usage.html


Quick Start
Expand Down
4 changes: 2 additions & 2 deletions speech/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand All @@ -41,7 +41,7 @@ and receive a text transcription from the Cloud Speech API service.
See the ``google-cloud-python`` API `speech documentation`_ to learn how to
connect to the Google Cloud Speech API using this Client Library.

.. _speech documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/speech-usage.html
.. _speech documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/speech/usage.html
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-speech.svg
:target: https://pypi.python.org/pypi/google-cloud-speech
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-speech.svg
Expand Down
6 changes: 3 additions & 3 deletions storage/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Google Cloud Storage

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/storage-client.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/storage/client.html

Quick Start
-----------
Expand All @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand All @@ -43,7 +43,7 @@ via direct download.
See the ``google-cloud-python`` API `storage documentation`_ to learn how to
connect to Cloud Storage using this Client Library.

.. _storage documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/storage-client.html
.. _storage documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/storage/client.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
2 changes: 1 addition & 1 deletion storage/google/cloud/storage/bucket.py
Original file line number Diff line number Diff line change
Expand Up @@ -1015,7 +1015,7 @@ def generate_upload_policy(
credentials = client._base_connection.credentials

if not isinstance(credentials, google.auth.credentials.Signing):
auth_uri = ('http://google-cloud-python.readthedocs.io/en/latest/'
auth_uri = ('https://google-cloud-python.readthedocs.io/en/latest/'
'core/auth.html?highlight=authentication#setting-up-'
'a-service-account')
raise AttributeError(
Expand Down
2 changes: 1 addition & 1 deletion translate/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down
6 changes: 1 addition & 5 deletions videointelligence/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ Python Client for Google Cloud Video Intelligence

|pypi| |versions|

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/video-intelligence-usage.html

Quick Start
-----------

Expand All @@ -26,7 +22,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down
4 changes: 2 additions & 2 deletions vision/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Python Client for Google Cloud Vision

- `Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/vision-usage.html
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/vision/usage.html

Quick Start
-----------
Expand All @@ -26,7 +26,7 @@ possible. 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/google-cloud-auth.html
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication

Using the API
Expand Down

0 comments on commit c6107a3

Please sign in to comment.