Skip to content

Commit 9a39085

Browse files
tswasttheacodes
authored andcommitted
Use subpackage installation instructions on main index. (googleapis#5459)
1 parent 577e9b9 commit 9a39085

19 files changed

Lines changed: 192 additions & 8 deletions

File tree

docs/bigquery/usage.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@ BigQuery
1010

1111
.. contents:: :local:
1212

13+
Installation
14+
------------
15+
16+
Install the ``google-cloud-bigquery`` library using ``pip``:
17+
18+
.. code-block:: console
19+
20+
$ pip install google-cloud-bigquery
21+
1322
.. note::
1423

1524
This library changed significantly before the 1.0.0 release, especially

docs/bigtable/usage.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ Bigtable
1919
data-api
2020
changelog
2121

22+
Installation
23+
------------
24+
25+
Install the ``google-cloud-bigtable`` library using ``pip``:
26+
27+
.. code-block:: console
28+
29+
$ pip install google-cloud-bigtable
30+
2231
API requests are sent to the `Google Cloud Bigtable`_ API via RPC over HTTP/2.
2332
In order to support this, we'll rely on `gRPC`_. We are working with the gRPC
2433
team to rapidly make the install story more user-friendly.

docs/datastore/usage.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ Datastore
1313
batches
1414
helpers
1515

16+
Installation
17+
------------
18+
19+
Install the ``google-cloud-datastore`` library using ``pip``:
20+
21+
.. code-block:: console
22+
23+
$ pip install google-cloud-datastore
24+
1625
Modules
1726
-------
1827

docs/dns/usage.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@ DNS
1010
resource-record-set
1111
changes
1212

13+
Installation
14+
------------
15+
16+
Install the ``google-cloud-dns`` library using ``pip``:
17+
18+
.. code-block:: console
19+
20+
$ pip install google-cloud-dns
21+
1322
Client
1423
------
1524

docs/error-reporting/usage.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ Stackdriver Error Reporting
88
client
99
util
1010

11+
Installation
12+
------------
13+
14+
Install the ``google-cloud-error-reporting`` library using ``pip``:
15+
16+
.. code-block:: console
17+
18+
$ pip install google-cloud-error-reporting
19+
1120
Authentication and Configuration
1221
--------------------------------
1322

docs/firestore/index.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Firestore
2-
---------
2+
=========
33

44
.. toctree::
55
:maxdepth: 2
@@ -15,6 +15,18 @@ Firestore
1515
types
1616
changelog
1717

18+
Installation
19+
------------
20+
21+
Install the ``google-cloud-firestore`` library using ``pip``:
22+
23+
.. code-block:: console
24+
25+
$ pip install google-cloud-firestore
26+
27+
Usage
28+
-----
29+
1830
.. automodule:: google.cloud.firestore_v1beta1
1931
.. autoclass:: google.cloud.firestore_v1beta1.GeoPoint
2032
:members:

docs/index.rst

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,6 @@ Google Cloud Client Library for Python
3636
Getting started
3737
---------------
3838

39-
The ``google-cloud`` library is ``pip`` install-able:
40-
41-
.. code-block:: console
42-
43-
$ pip install google-cloud
44-
4539
For more information on setting up your Python development environment,
4640
such as installing ``pip`` and ``virtualenv`` on your system, please refer
4741
to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
@@ -51,10 +45,20 @@ to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
5145
Cloud Datastore
5246
~~~~~~~~~~~~~~~
5347

54-
`Google Cloud Datastore`_ is a fully managed, schemaless database for storing non-relational data.
48+
`Google Cloud Datastore`_ is a fully managed, schemaless database for storing
49+
non-relational data.
5550

5651
.. _Google Cloud Datastore: https://cloud.google.com/datastore/
5752

53+
Install the ``google-cloud-datastore`` library using ``pip``:
54+
55+
.. code-block:: console
56+
57+
$ pip install google-cloud-datastore
58+
59+
Example
60+
^^^^^^^
61+
5862
.. code-block:: python
5963
6064
from google.cloud import datastore
@@ -74,6 +78,15 @@ Cloud Storage
7478

7579
.. _Google Cloud Storage: https://cloud.google.com/storage/
7680

81+
Install the ``google-cloud-storage`` library using ``pip``:
82+
83+
.. code-block:: console
84+
85+
$ pip install google-cloud-storage
86+
87+
Example
88+
^^^^^^^
89+
7790
.. code-block:: python
7891
7992
from google.cloud import storage

docs/language/usage.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,16 @@ with your document storage on Google Cloud Storage.
1313

1414
.. _Google Natural Language: https://cloud.google.com/natural-language/docs/quickstart-client-libraries
1515

16+
************
17+
Installation
18+
************
19+
20+
Install the ``google-cloud-language`` library using ``pip``:
21+
22+
.. code-block:: console
23+
24+
$ pip install google-cloud-language
25+
1626
1727
********************************
1828
Authentication and Configuration

docs/logging/usage.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,15 @@ Stackdriver Logging
1818
transports-thread
1919
transports-base
2020

21+
Installation
22+
------------
23+
24+
Install the ``google-cloud-logging`` library using ``pip``:
25+
26+
.. code-block:: console
27+
28+
$ pip install google-cloud-logging
29+
2130
Authentication and Configuration
2231
--------------------------------
2332

docs/pubsub/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ messages per second (and beyond).
1212

1313
.. _Google Cloud Pub/Sub: https://cloud.google.com/pubsub/
1414

15+
************
16+
Installation
17+
************
18+
19+
Install the ``google-cloud-pubsub`` library using ``pip``:
20+
21+
.. code-block:: console
22+
23+
$ pip install google-cloud-pubsub
24+
1525
********************************
1626
Authentication and Configuration
1727
********************************

0 commit comments

Comments
 (0)