Skip to content

Commit 35684f0

Browse files
authored
KMS: harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6021)
Toward #5912.
1 parent 01aad20 commit 35684f0

3 files changed

Lines changed: 19 additions & 75 deletions

File tree

kms/README.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Python Client for Cloud Key Management Service (KMS) API (`Alpha`_)
22
===================================================================
33

4+
|pypi| |versions|
5+
46
`Cloud Key Management Service (KMS) API`_: Manages keys and performs cryptographic operations in a central cloud
57
service, for direct use by other cloud resources and applications.
68

@@ -11,6 +13,10 @@ service, for direct use by other cloud resources and applications.
1113
.. _Cloud Key Management Service (KMS) API: https://cloud.google.com/kms
1214
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/kms/index.html
1315
.. _Product Documentation: https://cloud.google.com/kms
16+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-datastore.svg
17+
:target: https://pypi.org/project/google-cloud-datastore/
18+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-datastore.svg
19+
:target: https://pypi.org/project/google-cloud-datastore/
1420

1521
Quick Start
1622
-----------

kms/docs/changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CHANGELOG.md

kms/docs/index.rst

Lines changed: 12 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,21 @@
1-
Python Client for Cloud Key Management Service (KMS) API (`Alpha`_)
2-
===================================================================
1+
.. include:: /../kms/README.rst
32

4-
`Cloud Key Management Service (KMS) API`_: Manages keys and performs cryptographic operations in a central cloud
5-
service, for direct use by other cloud resources and applications.
63

7-
- `Client Library Documentation`_
8-
- `Product Documentation`_
9-
10-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
11-
.. _Cloud Key Management Service (KMS) API: https://cloud.google.com/kms
12-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/kms/index.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 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 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
4+
API Reference
5+
-------------
6+
.. toctree::
7+
:maxdepth: 2
598

60-
pip install virtualenv
61-
virtualenv <your-env>
62-
<your-env>\Scripts\activate
63-
<your-env>\Scripts\pip.exe install google-cloud-kms
9+
gapic/v1/api
10+
gapic/v1/types
6411

65-
Next Steps
66-
~~~~~~~~~~
6712

68-
- Read the `Client Library Documentation`_ for Cloud Key Management Service (KMS) API
69-
API to see other available methods on the client.
70-
- Read the `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.
13+
Changelog
14+
---------
7415

75-
.. _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
16+
For a list of all ``google-cloud-kms`` releases:
7717

78-
Api Reference
79-
-------------
8018
.. toctree::
81-
:maxdepth: 2
19+
:maxdepth: 2
8220

83-
gapic/v1/api
84-
gapic/v1/types
21+
changelog

0 commit comments

Comments
 (0)