diff --git a/containeranalysis/docs/index.rst b/containeranalysis/docs/index.rst index 4857da4f3bec..51824979bb1b 100644 --- a/containeranalysis/docs/index.rst +++ b/containeranalysis/docs/index.rst @@ -1,84 +1,20 @@ -Python Client for Container Analysis API (`Alpha`_) -=================================================== +.. include:: README.rst -`Container Analysis API`_: An implementation of the Grafeas API, which stores, and enables querying -and retrieval of critical metadata about all of your software artifacts. - -- `Client Library Documentation`_ -- `Product Documentation`_ - -.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst -.. _Container Analysis API: https://cloud.google.com/containeranalysis -.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/containeranalysis/usage.html -.. _Product Documentation: https://cloud.google.com/containeranalysis - -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 Container Analysis 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 Container Analysis API.: https://cloud.google.com/containeranalysis -.. _Setup Authentication.: https://googleapis.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-containeranalysis - - -Windows -^^^^^^^ - -.. code-block:: console +Api Reference +------------- +.. toctree:: + :maxdepth: 2 - pip install virtualenv - virtualenv - \Scripts\activate - \Scripts\pip.exe install google-cloud-containeranalysis + gapic/v1/api + gapic/v1/types -Next Steps -~~~~~~~~~~ -- Read the `Client Library Documentation`_ for Container Analysis API - API to see other available methods on the client. -- Read the `Container Analysis 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 +---------- -.. _Container Analysis API Product documentation: https://cloud.google.com/containeranalysis -.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst +For all previous ``google-cloud-containeranalysis`` releases: -Api Reference -------------- .. toctree:: :maxdepth: 2 - gapic/v1/api - gapic/v1/types \ No newline at end of file + changelog \ No newline at end of file diff --git a/containeranalysis/setup.py b/containeranalysis/setup.py index d55edd38e1e1..4c1762ed599e 100644 --- a/containeranalysis/setup.py +++ b/containeranalysis/setup.py @@ -27,7 +27,6 @@ release_status = '3 - Alpha' dependencies = [ 'google-api-core[grpc] >= 1.4.1, < 2.0.0dev', - 'grpc-google-iam-v1 >= 0.11.1, < 0.12dev', 'enum34; python_version < "3.4"', ] diff --git a/docs/requirements.txt b/docs/requirements.txt index feb344a44135..99fe149bddc7 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -14,7 +14,7 @@ grpcio-gcp >= 0.2.2 -e bigquery_storage/ -e bigtable/ -e container/ --e containeranlysis/ +-e containeranalysis/ -e datacatalog/ -e datalabeling/ -e dataproc/