Skip to content

Commit 26efddf

Browse files
tseavertseaver
committed
DRY out duplicated 'README.rst' vs. 'docs/index.rst'.
1 parent 09aea8a commit 26efddf

20 files changed

Lines changed: 23 additions & 817 deletions

File tree

‎asset/README.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Python Client for Cloud Asset API (`Alpha`_)
88

99
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1010
.. _Cloud Asset API: https://cloud.google.com/cloudasset
11-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/cloudasset/usage.html
11+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/asset/index.html
1212
.. _Product Documentation: https://cloud.google.com/cloudasset
1313

1414
Quick Start

‎asset/docs/index.rst‎

Lines changed: 1 addition & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,4 @@
1-
Python Client for Cloud Asset API (`Alpha`_)
2-
============================================
3-
4-
`Cloud Asset API`_: The cloud asset API manages the history and inventory of cloud resources.
5-
6-
- `Client Library Documentation`_
7-
- `Product Documentation`_
8-
9-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
10-
.. _Cloud Asset API: https://cloud.google.com/cloudasset
11-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/cloudasset/usage.html
12-
.. _Product Documentation: https://cloud.google.com/cloudasset
13-
14-
Quick Start
15-
-----------
16-
17-
In order to use this library, you first need to go through the following steps:
18-
19-
1. `Select or create a Cloud Platform project.`_
20-
2. `Enable billing for your project.`_
21-
3. `Enable the Cloud Asset API.`_
22-
4. `Setup Authentication.`_
23-
24-
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
25-
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
26-
.. _Enable the Cloud Asset API.: https://cloud.google.com/cloudasset
27-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
28-
29-
Installation
30-
~~~~~~~~~~~~
31-
32-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
33-
create isolated Python environments. The basic problem it addresses is one of
34-
dependencies and versions, and indirectly permissions.
35-
36-
With `virtualenv`_, it's possible to install this library without needing system
37-
install permissions, and without clashing with the installed system
38-
dependencies.
39-
40-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
41-
42-
43-
Mac/Linux
44-
^^^^^^^^^
45-
46-
.. code-block:: console
47-
48-
pip install virtualenv
49-
virtualenv <your-env>
50-
source <your-env>/bin/activate
51-
<your-env>/bin/pip install google-cloud-cloudasset
52-
53-
54-
Windows
55-
^^^^^^^
56-
57-
.. code-block:: console
58-
59-
pip install virtualenv
60-
virtualenv <your-env>
61-
<your-env>\Scripts\activate
62-
<your-env>\Scripts\pip.exe install google-cloud-cloudasset
63-
64-
Next Steps
65-
~~~~~~~~~~
66-
67-
- Read the `Client Library Documentation`_ for Cloud Asset API
68-
API to see other available methods on the client.
69-
- Read the `Cloud Asset API Product documentation`_ to learn
70-
more about the product and see How-to Guides.
71-
- View this `repository’s main README`_ to see the full list of Cloud
72-
APIs that we cover.
73-
74-
.. _Cloud Asset API Product documentation: https://cloud.google.com/cloudasset
75-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1+
.. include:: /../asset/README.rst
762

773
Api Reference
784
-------------

‎dlp/README.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ storage repositories.
1010

1111
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1212
.. _Cloud Data Loss Prevention (DLP) API: https://cloud.google.com/dlp
13-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/dlp/usage.html
13+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/dlp/index.html
1414
.. _Product Documentation: https://cloud.google.com/dlp
1515

1616
Quick Start

‎dlp/docs/index.rst‎

Lines changed: 1 addition & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,4 @@
1-
Python Client for Cloud Data Loss Prevention (DLP) API (`Alpha`_)
2-
=================================================================
3-
4-
`Cloud Data Loss Prevention (DLP) API`_: Provides methods for detection, risk analysis, and de-identification of
5-
privacy-sensitive fragments in text, images, and Google Cloud Platform
6-
storage repositories.
7-
8-
- `Client Library Documentation`_
9-
- `Product Documentation`_
10-
11-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
12-
.. _Cloud Data Loss Prevention (DLP) API: https://cloud.google.com/dlp
13-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/dlp/usage.html
14-
.. _Product Documentation: https://cloud.google.com/dlp
15-
16-
Quick Start
17-
-----------
18-
19-
In order to use this library, you first need to go through the following steps:
20-
21-
1. `Select or create a Cloud Platform project.`_
22-
2. `Enable billing for your project.`_
23-
3. `Enable the Cloud Data Loss Prevention (DLP) API.`_
24-
4. `Setup Authentication.`_
25-
26-
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
27-
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
28-
.. _Enable the Cloud Data Loss Prevention (DLP) API.: https://cloud.google.com/dlp
29-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
30-
31-
Installation
32-
~~~~~~~~~~~~
33-
34-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
35-
create isolated Python environments. The basic problem it addresses is one of
36-
dependencies and versions, and indirectly permissions.
37-
38-
With `virtualenv`_, it's possible to install this library without needing system
39-
install permissions, and without clashing with the installed system
40-
dependencies.
41-
42-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
43-
44-
45-
Mac/Linux
46-
^^^^^^^^^
47-
48-
.. code-block:: console
49-
50-
pip install virtualenv
51-
virtualenv <your-env>
52-
source <your-env>/bin/activate
53-
<your-env>/bin/pip install google-cloud-dlp
54-
55-
56-
Windows
57-
^^^^^^^
58-
59-
.. code-block:: console
60-
61-
pip install virtualenv
62-
virtualenv <your-env>
63-
<your-env>\Scripts\activate
64-
<your-env>\Scripts\pip.exe install google-cloud-dlp
65-
66-
Next Steps
67-
~~~~~~~~~~
68-
69-
- Read the `Client Library Documentation`_ for Cloud Data Loss Prevention (DLP) API
70-
API to see other available methods on the client.
71-
- Read the `Cloud Data Loss Prevention (DLP) API Product documentation`_ to learn
72-
more about the product and see How-to Guides.
73-
- View this `repository’s main README`_ to see the full list of Cloud
74-
APIs that we cover.
75-
76-
.. _Cloud Data Loss Prevention (DLP) API Product documentation: https://cloud.google.com/dlp
77-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1+
.. include:: /../dlp/README.rst
782

793
Api Reference
804
-------------

‎iot/README.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Google Cloud Platform.
99

1010
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1111
.. _Cloud IoT API: https://cloud.google.com/iot
12-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/iot/usage.html
12+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/iot/index.html
1313
.. _Product Documentation: https://cloud.google.com/iot
1414

1515
Quick Start

‎iot/docs/index.rst‎

Lines changed: 1 addition & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,4 @@
1-
Python Client for Cloud IoT API (`Alpha`_)
2-
==========================================
3-
4-
`Cloud IoT API`_: Registers and manages IoT (Internet of Things) devices that connect to the
5-
Google Cloud Platform.
6-
7-
- `Client Library Documentation`_
8-
- `Product Documentation`_
9-
10-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
11-
.. _Cloud IoT API: https://cloud.google.com/iot
12-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/iot/index.html
13-
.. _Product Documentation: https://cloud.google.com/iot
14-
15-
Quick Start
16-
-----------
17-
18-
In order to use this library, you first need to go through the following steps:
19-
20-
1. `Select or create a Cloud Platform project.`_
21-
2. `Enable billing for your project.`_
22-
3. `Enable the Cloud IoT API.`_
23-
4. `Setup Authentication.`_
24-
25-
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
26-
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
27-
.. _Enable the Cloud IoT API.: https://cloud.google.com/iot
28-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
29-
30-
Installation
31-
~~~~~~~~~~~~
32-
33-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
34-
create isolated Python environments. The basic problem it addresses is one of
35-
dependencies and versions, and indirectly permissions.
36-
37-
With `virtualenv`_, it's possible to install this library without needing system
38-
install permissions, and without clashing with the installed system
39-
dependencies.
40-
41-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
42-
43-
44-
Mac/Linux
45-
^^^^^^^^^
46-
47-
.. code-block:: console
48-
49-
pip install virtualenv
50-
virtualenv <your-env>
51-
source <your-env>/bin/activate
52-
<your-env>/bin/pip install google-cloud-iot
53-
54-
55-
Windows
56-
^^^^^^^
57-
58-
.. code-block:: console
59-
60-
pip install virtualenv
61-
virtualenv <your-env>
62-
<your-env>\Scripts\activate
63-
<your-env>\Scripts\pip.exe install google-cloud-iot
64-
65-
Preview
66-
~~~~~~~
67-
68-
DeviceManagerClient
69-
^^^^^^^^^^^^^^^^^^^
70-
71-
.. code:: py
72-
73-
from google.cloud import iot_v1
74-
75-
client = iot_v1.DeviceManagerClient()
76-
77-
parent = client.location_path('[PROJECT]', '[LOCATION]')
78-
79-
80-
# Iterate over all results
81-
for element in client.list_device_registries(parent):
82-
# process element
83-
pass
84-
85-
# Or iterate over results one page at a time
86-
for page in client.list_device_registries(parent, options=CallOptions(page_token=INITIAL_PAGE)):
87-
for element in page:
88-
# process element
89-
pass
90-
91-
Next Steps
92-
~~~~~~~~~~
93-
94-
- Read the `Client Library Documentation`_ for Cloud IoT API
95-
API to see other available methods on the client.
96-
- Read the `Cloud IoT API Product documentation`_ to learn
97-
more about the product and see How-to Guides.
98-
- View this `repository’s main README`_ to see the full list of Cloud
99-
APIs that we cover.
100-
101-
.. _Cloud IoT API Product documentation: https://cloud.google.com/iot
102-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1+
.. include:: /../iot/README.rst
1032

1043
Api Reference
1054
-------------

‎kms/README.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You can generate, use, rotate, and destroy AES256 encryption keys.
99

1010
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1111
.. _Google Cloud Key Management Service (KMS) API: https://cloud.google.com/kms
12-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/kms/usage.html
12+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/kms/index.html
1313
.. _Product Documentation: https://cloud.google.com/kms
1414

1515
Quick Start

‎kms/docs/index.rst‎

Lines changed: 1 addition & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,4 @@
1-
Python Client for Google Cloud Key Management Service (KMS) API (`Alpha`_)
2-
==========================================================================
3-
4-
`Google Cloud Key Management Service (KMS) API`_: Manages encryption for your cloud services the same way you do on-premises.
5-
You can generate, use, rotate, and destroy AES256 encryption keys.
6-
7-
- `Client Library Documentation`_
8-
- `Product Documentation`_
9-
10-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
11-
.. _Google Cloud Key Management Service (KMS) API: https://cloud.google.com/kms
12-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/kms/usage.html
13-
.. _Product Documentation: https://cloud.google.com/kms
14-
15-
Quick Start
16-
-----------
17-
18-
In order to use this library, you first need to go through the following steps:
19-
20-
1. `Select or create a Cloud Platform project.`_
21-
2. `Enable billing for your project.`_
22-
3. `Enable the Google Cloud Key Management Service (KMS) API.`_
23-
4. `Setup Authentication.`_
24-
25-
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
26-
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
27-
.. _Enable the Google Cloud Key Management Service (KMS) API.: https://cloud.google.com/kms
28-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
29-
30-
Installation
31-
~~~~~~~~~~~~
32-
33-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
34-
create isolated Python environments. The basic problem it addresses is one of
35-
dependencies and versions, and indirectly permissions.
36-
37-
With `virtualenv`_, it's possible to install this library without needing system
38-
install permissions, and without clashing with the installed system
39-
dependencies.
40-
41-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
42-
43-
44-
Mac/Linux
45-
^^^^^^^^^
46-
47-
.. code-block:: console
48-
49-
pip install virtualenv
50-
virtualenv <your-env>
51-
source <your-env>/bin/activate
52-
<your-env>/bin/pip install google-cloud-kms
53-
54-
55-
Windows
56-
^^^^^^^
57-
58-
.. code-block:: console
59-
60-
pip install virtualenv
61-
virtualenv <your-env>
62-
<your-env>\Scripts\activate
63-
<your-env>\Scripts\pip.exe install google-cloud-kms
64-
65-
Next Steps
66-
~~~~~~~~~~
67-
68-
- Read the `Client Library Documentation`_ for Google Cloud Key Management Service (KMS) API
69-
API to see other available methods on the client.
70-
- Read the `Google Cloud Key Management Service (KMS) API Product documentation`_ to learn
71-
more about the product and see How-to Guides.
72-
- View this `repository’s main README`_ to see the full list of Cloud
73-
APIs that we cover.
74-
75-
.. _Google Cloud Key Management Service (KMS) API Product documentation: https://cloud.google.com/kms
76-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1+
.. include:: /../kms/README.rst
772

783
Api Reference
794
-------------

‎oslogin/README.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Python Client for Google Cloud OS Login API (`Alpha`_)
88

99
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
1010
.. _Google Cloud OS Login API: https://cloud.google.com/os-login
11-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/os-login/usage.html
11+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/oslogin/index.html
1212
.. _Product Documentation: https://cloud.google.com/os-login
1313

1414
Quick Start

0 commit comments

Comments
 (0)