Skip to content

Commit

Permalink
Link to googleapis.dev documentation in READMEs. (#8705)
Browse files Browse the repository at this point in the history
  • Loading branch information
busunkim96 authored Jul 19, 2019
1 parent 506aa4b commit 951b9c6
Show file tree
Hide file tree
Showing 55 changed files with 110 additions and 118 deletions.
8 changes: 0 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,6 @@ Python idiomatic clients for `Google Cloud Platform`_ services.

.. _Google Cloud Platform: https://cloud.google.com/

- `Homepage`_
- `API Documentation`_
- `Read The Docs Documentation`_

.. _Homepage: https://googleapis.github.io/google-cloud-python/
.. _API Documentation: https://googleapis.github.io/google-cloud-python/latest/
.. _Read The Docs Documentation: https://google-cloud-python.readthedocs.io/en/latest/

**Heads up**! These libraries are supported on App Engine standard's `Python 3 runtime`_ but are *not* supported on App Engine's `Python 2 runtime`_.

.. _Python 3 runtime: https://cloud.google.com/appengine/docs/standard/python3
Expand Down
2 changes: 1 addition & 1 deletion api_core/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ common helpers used by all Google API clients. For more information, see the
:target: https://pypi.org/project/google-api_core/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-api_core.svg
:target: https://pypi.org/project/google-api_core/
.. _documentation: https://googleapis.github.io/google-cloud-python/latest/core/
.. _documentation: https://googleapis.dev/python/google-api-core/latest
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-api-core
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-api-core
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dapi_core
Expand Down
10 changes: 10 additions & 0 deletions api_core/docs/futures.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Futures
=======================

.. automodule:: google.api_core.future
:members:
:show-inheritance:

.. automodule:: google.api_core.future.polling
:members:
:show-inheritance:
1 change: 1 addition & 0 deletions api_core/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Core
auth
client_info
exceptions
futures
helpers
iam
operation
Expand Down
2 changes: 1 addition & 1 deletion api_core/google/api_core/future/polling.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class PollingFuture(base.Future):
behavior will repeatedly call ``done`` until it returns True.
.. note: Privacy here is intended to prevent the final class from
overexposing, not to prevent subclasses from accessing methods.
overexposing, not to prevent subclasses from accessing methods.
Args:
retry (google.api_core.retry.Retry): The retry configuration used
Expand Down
4 changes: 2 additions & 2 deletions asset/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Python Client for Cloud Asset API
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dasset
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dasset
.. _Cloud Asset API: https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/reference/rest/
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/asset/index.html
.. _Client Library Documentation: https://googleapis.dev/python/asset/latest
.. _Product Documentation: https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview

Quick Start
Expand All @@ -35,7 +35,7 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Cloud Asset API.: https://console.cloud.google.com/apis/library/cloudasset.googleapis.com
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions automl/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ transfer learning, and Neural Architecture Search technology.
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dautoml
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dautoml
.. _Cloud AutoML API: https://cloud.google.com/automl
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/automl/index.html
.. _Client Library Documentation: https://googleapis.dev/python/automl/latest
.. _Product Documentation: https://cloud.google.com/automl

Quick Start
Expand All @@ -38,7 +38,7 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Cloud AutoML API.: https://cloud.google.com/automl
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions bigquery/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ processing power of Google's infrastructure.
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery
.. _BigQuery: https://cloud.google.com/bigquery/what-is-bigquery
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/bigquery/index.html
.. _Client Library Documentation: https://googleapis.dev/python/bigquery/latest
.. _Product Documentation: https://cloud.google.com/bigquery/docs/reference/v2/

Quick Start
Expand All @@ -38,7 +38,7 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Google Cloud BigQuery API.: https://cloud.google.com/bigquery
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions bigquery_datatransfer/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ SaaS applications to Google BigQuery on a scheduled, managed basis.
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery_datatransfer
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery_datatransfer
.. _BigQuery Data Transfer API: https://cloud.google.com/bigquery/transfer
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/bigquery_datatransfer/index.html
.. _Client Library Documentation: https://googleapis.dev/python/bigquery-datatransfer/latest
.. _Product Documentation: https://cloud.google.com/bigquery/docs/transfer-service-overview

Quick Start
Expand All @@ -34,7 +34,7 @@ In order to use this library, you first need to go through the following steps:

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable the BigQuery Data Transfer API.: https://cloud.google.com/bigquery/docs/transfer-service-overview
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions bigquery_storage/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Python Client for BigQuery Storage API (`Beta`_)
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigquery_storage
.. _Beta: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _BigQuery Storage API: https://cloud.google.com/bigquery/docs/reference/storage/
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/bigquery_storage/index.html
.. _Client Library Documentation: https://googleapis.dev/python/bigquery-storage/latest
.. _Product Documentation: https://cloud.google.com/bigquery/docs/reference/storage/

Quick Start
Expand All @@ -30,7 +30,7 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the BigQuery Storage API.: https://console.cloud.google.com/apis/library/bigquerystorage.googleapis.com
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions bigtable/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Analytics, Maps, and Gmail.
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigtable
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dbigtable
.. _Google Cloud Bigtable: https://cloud.google.com/bigtable
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/bigtable/usage.html
.. _Client Library Documentation: https://googleapis.dev/python/bigtable/latest
.. _Product Documentation: https://cloud.google.com/bigtable/docs

Quick Start
Expand All @@ -37,7 +37,7 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Cloud Bigtable API.: https://cloud.google.com/bigtable
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
6 changes: 3 additions & 3 deletions container/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Kubernetes technology.
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dcontainer
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dcontainer
.. _Google Kubernetes Engine API: https://cloud.google.com/kubernetes-engine
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/container/index.html
.. _Client Library Documentation: https://googleapis.dev/python/container/latest
.. _Product Documentation: https://cloud.google.com/kubernetes-engine

Quick Start
Expand All @@ -35,7 +35,7 @@ In order to use this library, you first need to go through the following steps:

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable the Google Container Engine API.: https://cloud.google.com/container
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down Expand Up @@ -102,4 +102,4 @@ Next Steps
- Read the `Product documentation`_ to learn more about the product and see
How-to Guides.

.. _Client API Documentation: https://googleapis.github.io/google-cloud-python/latest/container/gapic/v1/api.html
.. _Client API Documentation: https://googleapis.dev/python/container/latest
4 changes: 2 additions & 2 deletions containeranalysis/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and retrieval of critical metadata about all of your software artifacts.

.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _Container Analysis API: https://cloud.google.com/container-registry/docs/container-analysis
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/containeranalysis/index.html
.. _Client Library Documentation: https://googleapis.dev/python/containeranalysis/latest/index.html
.. _Product Documentation: https://cloud.google.com/container-registry/docs/container-analysis

Quick Start
Expand All @@ -25,7 +25,7 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Container Analysis API.: https://cloud.google.com/container-registry/docs/container-analysis
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions containeranalysis/docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and retrieval of critical metadata about all of your software artifacts.

.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _Container Analysis API: https://cloud.google.com/container-registry/docs/container-analysis
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/containeranalysis/usage.html
.. _Client Library Documentation: https://googleapis.dev/python/containeranalysis/latest
.. _Product Documentation: https://cloud.google.com/container-registry/docs/container-analysis

Quick Start
Expand All @@ -25,7 +25,7 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Container Analysis API.: https://cloud.google.com/container-registry/docs/container-analysis
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/containeranalysis/latest

Installation
~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion core/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ common helpers (e.g. base ``Client`` classes) used by all of the
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-core
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dcore
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dcore
.. _Documentation: https://googleapis.github.io/google-cloud-python/latest/core/index.html
.. _Documentation: https://googleapis.dev/python/google-cloud-core/latest

Quick Start
-----------
Expand Down
4 changes: 2 additions & 2 deletions datacatalog/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ include: Entries (Data Catalog representation of a cloud resource).
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Ddatacatalog
.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _Google Cloud Data Catalog API: https://cloud.google.com/data-catalog
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/datacatalog/index.html
.. _Client Library Documentation: https://cloud.google.com/nodejs/docs/reference/datacatalog/latest/
.. _Product Documentation: https://cloud.google.com/data-catalog

Quick Start
Expand All @@ -32,7 +32,7 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Google Cloud Data Catalog API.: https://cloud.google.com/data-catalog
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions datalabeling/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Python Client for Data Labeling API (`Beta`_)
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Ddatalabeling
.. _Beta: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. _Data Labeling API: https://cloud.google.com/data-labeling
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/datalabeling/index.html
.. _Client Library Documentation: https://googleapis.dev/python/datalabeling/latest
.. _Product Documentation: https://cloud.google.com/data-labeling/docs/

Quick Start
Expand All @@ -30,7 +30,7 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Data Labeling API.: https://cloud.google.com/data-labeling
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions dataproc/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Python Client for Google Cloud Dataproc API
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Ddataproc
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Ddataproc
.. _Google Cloud Dataproc API: https://cloud.google.com/dataproc
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/dataproc/index.html
.. _Client Library Documentation: https://googleapis.dev/python/dataproc/latest
.. _Product Documentation: https://cloud.google.com/dataproc

Quick Start
Expand All @@ -35,7 +35,7 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Google Cloud Dataproc API.: https://cloud.google.com/dataproc
.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~
Expand Down
Loading

0 comments on commit 951b9c6

Please sign in to comment.