From 35684f0d70099ea650f5bc93fd1c6ba7ff61ed51 Mon Sep 17 00:00:00 2001 From: Tres Seaver Date: Fri, 21 Sep 2018 11:36:17 -0400 Subject: [PATCH] KMS: harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6021) Toward #5912. --- kms/README.rst | 6 +++ kms/docs/changelog.md | 1 + kms/docs/index.rst | 87 ++++++------------------------------------- 3 files changed, 19 insertions(+), 75 deletions(-) create mode 120000 kms/docs/changelog.md diff --git a/kms/README.rst b/kms/README.rst index 85e3ed9373b3..c0aee0ab4f95 100644 --- a/kms/README.rst +++ b/kms/README.rst @@ -1,6 +1,8 @@ Python Client for Cloud Key Management Service (KMS) API (`Alpha`_) =================================================================== +|pypi| |versions| + `Cloud Key Management Service (KMS) API`_: Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications. @@ -11,6 +13,10 @@ service, for direct use by other cloud resources and applications. .. _Cloud Key Management Service (KMS) API: https://cloud.google.com/kms .. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/kms/index.html .. _Product Documentation: https://cloud.google.com/kms +.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-datastore.svg + :target: https://pypi.org/project/google-cloud-datastore/ +.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-datastore.svg + :target: https://pypi.org/project/google-cloud-datastore/ Quick Start ----------- diff --git a/kms/docs/changelog.md b/kms/docs/changelog.md new file mode 120000 index 000000000000..04c99a55caae --- /dev/null +++ b/kms/docs/changelog.md @@ -0,0 +1 @@ +../CHANGELOG.md \ No newline at end of file diff --git a/kms/docs/index.rst b/kms/docs/index.rst index 42ebe893e9fe..cc9201cb05fe 100644 --- a/kms/docs/index.rst +++ b/kms/docs/index.rst @@ -1,84 +1,21 @@ -Python Client for Cloud Key Management Service (KMS) API (`Alpha`_) -=================================================================== +.. include:: /../kms/README.rst -`Cloud Key Management Service (KMS) API`_: Manages keys and performs cryptographic operations in a central cloud -service, for direct use by other cloud resources and applications. -- `Client Library Documentation`_ -- `Product Documentation`_ - -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst -.. _Cloud Key Management Service (KMS) API: https://cloud.google.com/kms -.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/kms/index.html -.. _Product Documentation: https://cloud.google.com/kms - -Quick Start ------------ - -In order to use this library, you first need to go through the following steps: - -1. `Select or create a Cloud Platform project.`_ -2. `Enable billing for your project.`_ -3. `Enable the Cloud Key Management Service (KMS) API.`_ -4. `Setup Authentication.`_ - -.. _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 Key Management Service (KMS) API.: https://cloud.google.com/kms -.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - pip install virtualenv - virtualenv - source /bin/activate - /bin/pip install google-cloud-kms - - -Windows -^^^^^^^ - -.. code-block:: console +API Reference +------------- +.. toctree:: + :maxdepth: 2 - pip install virtualenv - virtualenv - \Scripts\activate - \Scripts\pip.exe install google-cloud-kms + gapic/v1/api + gapic/v1/types -Next Steps -~~~~~~~~~~ -- Read the `Client Library Documentation`_ for Cloud Key Management Service (KMS) API - API to see other available methods on the client. -- Read the `Cloud Key Management Service (KMS) API Product documentation`_ to learn - more about the product and see How-to Guides. -- View this `repository’s main README`_ to see the full list of Cloud - APIs that we cover. +Changelog +--------- -.. _Cloud Key Management Service (KMS) API Product documentation: https://cloud.google.com/kms -.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst +For a list of all ``google-cloud-kms`` releases: -Api Reference -------------- .. toctree:: - :maxdepth: 2 + :maxdepth: 2 - gapic/v1/api - gapic/v1/types + changelog