Skip to content

Commit

Permalink
Fix docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
busunkim96 committed Jun 6, 2019
1 parent c8ec956 commit cefd269
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 77 deletions.
86 changes: 11 additions & 75 deletions containeranalysis/docs/index.rst
Original file line number Diff line number Diff line change
@@ -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 <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-containeranalysis
Windows
^^^^^^^

.. code-block:: console
Api Reference
-------------
.. toctree::
:maxdepth: 2

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\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
changelog
1 change: 0 additions & 1 deletion containeranalysis/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"',
]
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down

0 comments on commit cefd269

Please sign in to comment.