8000 Fix docs. · googleapis/google-cloud-python@cefd269 · GitHub
[go: up one dir, main page]
Skip to content

Commit cefd269

Browse files
busunkim96busunkim96
committed
Fix docs.
1 parent c8ec956 commit cefd269

File tree

3 files changed

+12
-77
lines changed

3 files changed

+12
-77
lines changed

‎containeranalysis/docs/index.rst‎

Lines changed: 11 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,20 @@
1-
Python Client for Container Analysis API (`Alpha`_)
2-
===================================================
1+
.. include:: README.rst
32

4-
`Container Analysis API`_: An implementation of the Grafeas API, which stores, and enables querying
5-
and retrieval of critical metadata about all of your software artifacts.
6-
7-
- `Client Library Documentation`_
8-
- `Product Documentation`_
9-
10-
.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
11-
.. _Container Analysis API: https://cloud.google.com/containeranalysis
12-
.. _Client Library Documentation: https://googleapis.github.io/google-cloud-python/latest/containeranalysis/usage.html
13-
.. _Product Documentation: https://cloud.google.com/containeranalysis
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 Container Analysis 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 Container Analysis API.: https://cloud.google.com/containeranalysis
28-
.. _Setup Authentication.: https://googleapis.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-containeranalysis
53-
54-
55-
Windows
56-
^^^^^^^
57-
58-
.. code-block:: console
3+
Api Reference
4+
-------------
5+
.. toctree::
6+
:maxdepth: 2
597

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

65-
Next Steps
66-
~~~~~~~~~~
6711

68-
- Read the `Client Library Documentation`_ for Container Analysis API
69-
API to see other available methods on the client.
70-
- Read the `Container Analysis 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.
12+
Changelog
13+
----------
7414

75-
.. _Container Analysis API Product documentation: https://cloud.google.com/containeranalysis
76-
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
15+
For all previous ``google-cloud-containeranalysis`` releases:
7716

78-
Api Reference
79-
-------------
8017
.. toctree::
8118
:maxdepth: 2
8219

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

‎containeranalysis/setup.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
release_status = '3 - Alpha'
2828
dependencies = [
2929
'google-api-core[grpc] >= 1.4.1, < 2.0.0dev',
30-
3130
'grpc-google-iam-v1 >= 0.11.1, < 0.12dev',
3231
'enum34; python_version < "3.4"',
3332
]

‎docs/requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ grpcio-gcp >= 0.2.2
1414
-e bigquery_storage/
1515
-e bigtable/
1616
-e container/
17-
-e containeranlysis/
17+
-e containeranalysis/
1818
-e datacatalog/
1919
-e datalabeling/
2020
-e dataproc/

0 commit comments

Comments
 (0)
0