From f560c658afdb67cf2ed5194cf334dd737b4ac987 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Wed, 5 Aug 2015 10:34:09 -0700 Subject: [PATCH 1/4] Renaming some .rst docs since captions now hold headings. Removing the out-of-date, hard to find _components/*-quickstart.rst as well. Folded documentation for connections in client documentation, since we don't really ever need to talk about a connection without a client. --- docs/_components/datastore-quickstart.rst | 65 ----------------- docs/_components/storage-quickstart.rst | 82 ---------------------- docs/bigquery-usage.rst | 10 +-- docs/datastore-client.rst | 10 ++- docs/datastore-overview.rst | 11 --- docs/gcloud-api.rst | 26 +++---- docs/index.rst | 5 +- docs/{pubsub-api.rst => pubsub-client.rst} | 13 +--- docs/storage-api.rst | 16 ----- docs/storage-client.rst | 15 ++++ 10 files changed, 43 insertions(+), 210 deletions(-) delete mode 100644 docs/_components/datastore-quickstart.rst delete mode 100644 docs/_components/storage-quickstart.rst delete mode 100644 docs/datastore-overview.rst rename docs/{pubsub-api.rst => pubsub-client.rst} (67%) delete mode 100644 docs/storage-api.rst create mode 100644 docs/storage-client.rst diff --git a/docs/_components/datastore-quickstart.rst b/docs/_components/datastore-quickstart.rst deleted file mode 100644 index 8a5d8ef51720..000000000000 --- a/docs/_components/datastore-quickstart.rst +++ /dev/null @@ -1,65 +0,0 @@ -Cloud Datastore in 10 seconds -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Install the library -^^^^^^^^^^^^^^^^^^^ - -The source code for the library -(and demo code) -lives on GitHub, -You can install the library quickly with ``pip``:: - - $ pip install gcloud - -Run the demo -^^^^^^^^^^^^ - -In order to run the demo, you need to have registred an actual ``gcloud`` -project and so you'll need to provide some environment variables to facilitate -authentication to your project: - - - ``GCLOUD_TESTS_PROJECT_ID``: Developers Console project ID (e.g. - bamboo-shift-455). - - ``GCLOUD_TESTS_DATASET_ID``: The name of the dataset your tests connect to. - This is typically the same as ``GCLOUD_TESTS_PROJECT_ID``. - - ``GOOGLE_APPLICATION_CREDENTIALS``: The path to a JSON key file; - see ``system_tests/app_credentials.json.sample`` as an example. Such a file - can be downloaded directly from the developer's console by clicking - "Generate new JSON key". See private key - `docs `__ - for more details. - -Run the -`example script `_ -included in the package:: - - $ python -m gcloud.datastore.demo - -And that's it! -You just read and wrote a bunch of data -to the Cloud Datastore. - -Try it yourself -^^^^^^^^^^^^^^^ - -You can interact with a demo dataset -in a Python interactive shell. - -Start by importing the demo module -and initializing the demo settings:: - - >>> from gcloud.datastore import demo - >>> demo.initialize() - -Once you have initialized, -you can create entities and save them:: - - >>> from gcloud import datastore - >>> entity = datastore.Entity(key=datastore.Key('Person')) - >>> entity['name'] = 'Your name' - >>> entity['age'] = 25 - >>> datastore.put(entity) - >>> list(datastore.Query(kind='Person').fetch()) - [] - ----- diff --git a/docs/_components/storage-quickstart.rst b/docs/_components/storage-quickstart.rst deleted file mode 100644 index 647985aea7c0..000000000000 --- a/docs/_components/storage-quickstart.rst +++ /dev/null @@ -1,82 +0,0 @@ -Cloud Storage in 10 seconds -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Install the library -^^^^^^^^^^^^^^^^^^^ - -The source code for the library -(and demo code) -lives on GitHub, -You can install the library quickly with ``pip``:: - - $ pip install gcloud - -Run the demo -^^^^^^^^^^^^ - -In order to run the demo, you need to have registred an actual ``gcloud`` -project and so you'll need to provide some environment variables to facilitate -authentication to your project: - - - ``GCLOUD_TESTS_PROJECT_ID``: Developers Console project ID (e.g. - bamboo-shift-455). - - ``GCLOUD_TESTS_DATASET_ID``: The name of the dataset your tests connect to. - This is typically the same as ``GCLOUD_TESTS_PROJECT_ID``. - - ``GOOGLE_APPLICATION_CREDENTIALS``: The path to a JSON key file; - see ``system_tests/app_credentials.json.sample`` as an example. Such a file - can be downloaded directly from the developer's console by clicking - "Generate new JSON key". See private key - `docs `__ - for more details. - -Run the -`example script `_ -included in the package:: - - $ python -m gcloud.storage.demo - -And that's it! -You should be walking through -a demonstration of using ``gcloud.storage`` -to read and write data to Google Cloud Storage. - -Try it yourself -^^^^^^^^^^^^^^^ - -You can interact with a demo dataset -in a Python interactive shell. - -Start by importing the demo module -and instantiating the demo connection:: - - >>> from gcloud.storage import demo - >>> connection = demo.get_connection() - -Once you have the connection, -you can create buckets and blobs:: - - >>> from gcloud import storage - >>> client.list_buckets() - [, ...] - >>> bucket = client.create_bucket('my-new-bucket') - >>> print bucket - - >>> blob = bucket.blob('my-test-file.txt') - >>> print blob - - >>> blob = blob.upload_from_string('this is test content!') - >>> print blob.download_as_string() - 'this is test content!' - >>> print bucket.list_blobs() - [] - >>> blob.delete() - >>> bucket.delete() - -.. note:: - The ``get_connection`` method is just a shortcut for:: - - >>> from gcloud import storage - >>> from gcloud.storage import demo - >>> connection = storage.get_connection(demo.PROJECT_ID) - ----- diff --git a/docs/bigquery-usage.rst b/docs/bigquery-usage.rst index 92032a4f72dd..fb6fad893e2d 100644 --- a/docs/bigquery-usage.rst +++ b/docs/bigquery-usage.rst @@ -1,9 +1,5 @@ -.. toctree:: - :maxdepth: 0 - :hidden: - -BigQuery -======== +Using the API +============= Authorization / Configuration ----------------------------- @@ -298,7 +294,7 @@ Run a query which can be expected to complete within bounded time: [(15,)] .. note:: - + If the query takes longer than the timeout allowed, ``results.job_complete`` will be ``False``: we therefore poll until it is completed. diff --git a/docs/datastore-client.rst b/docs/datastore-client.rst index c8f63ce7c303..a91e32b9a72a 100644 --- a/docs/datastore-client.rst +++ b/docs/datastore-client.rst @@ -1,7 +1,15 @@ Client -~~~~~~ +====== .. automodule:: gcloud.datastore.client :members: :undoc-members: :show-inheritance: + +Connection +~~~~~~~~~~ + +.. automodule:: gcloud.datastore.connection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/datastore-overview.rst b/docs/datastore-overview.rst deleted file mode 100644 index 37dadcfa30b4..000000000000 --- a/docs/datastore-overview.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. toctree:: - :maxdepth: 0 - :hidden: - -Datastore ---------- - -.. include:: _components/datastore-quickstart.rst - -Now check out the documentation for -:class:`Client `. diff --git a/docs/gcloud-api.rst b/docs/gcloud-api.rst index feab47583b50..2b11aa4244ec 100644 --- a/docs/gcloud-api.rst +++ b/docs/gcloud-api.rst @@ -1,30 +1,26 @@ -.. toctree:: - :maxdepth: 1 - :hidden: +Shared Core Modules +------------------- -GCloud Package --------------- - -:mod:`gcloud` -~~~~~~~~~~~~~ +Base Client +~~~~~~~~~~~ -.. automodule:: gcloud.__init__ +.. automodule:: gcloud.client :members: :undoc-members: :show-inheritance: -Connections -~~~~~~~~~~~ +Credentials Helpers +~~~~~~~~~~~~~~~~~~~ -.. automodule:: gcloud.connection +.. automodule:: gcloud.credentials :members: :undoc-members: :show-inheritance: -Credentials -~~~~~~~~~~~ +Base Connections +~~~~~~~~~~~~~~~~ -.. automodule:: gcloud.credentials +.. automodule:: gcloud.connection :members: :undoc-members: :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index de647426ab81..efc37b3eed18 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,6 @@ :hidden: :caption: Datastore - datastore-overview datastore-client datastore-entities datastore-keys @@ -23,7 +22,7 @@ :hidden: :caption: Storage - storage-api + storage-client storage-blobs storage-buckets storage-acl @@ -33,8 +32,8 @@ :hidden: :caption: Pub/Sub - pubsub-api pubsub-usage + pubsub-client pubsub-topic pubsub-subscription diff --git a/docs/pubsub-api.rst b/docs/pubsub-client.rst similarity index 67% rename from docs/pubsub-api.rst rename to docs/pubsub-client.rst index 434cd7c2c5aa..3f8b64c7731b 100644 --- a/docs/pubsub-api.rst +++ b/docs/pubsub-client.rst @@ -1,20 +1,13 @@ -.. toctree:: - :maxdepth: 1 - :hidden: - -Pub/Sub -------- - Client -~~~~~~~~~~~ +======== .. automodule:: gcloud.pubsub.client :members: :undoc-members: :show-inheritance: -Connections -~~~~~~~~~~~ +Connection +~~~~~~~~~~ .. automodule:: gcloud.pubsub.connection :members: diff --git a/docs/storage-api.rst b/docs/storage-api.rst deleted file mode 100644 index 863d0dbf9e95..000000000000 --- a/docs/storage-api.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. toctree:: - :maxdepth: 0 - :hidden: - -Storage -------- - -.. include:: _components/storage-quickstart.rst - -Connections -~~~~~~~~~~~ - -.. automodule:: gcloud.storage.connection - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/storage-client.rst b/docs/storage-client.rst new file mode 100644 index 000000000000..83bddb9dce0a --- /dev/null +++ b/docs/storage-client.rst @@ -0,0 +1,15 @@ +Client +====== + +.. automodule:: gcloud.storage.client + :members: + :undoc-members: + :show-inheritance: + +Connection +~~~~~~~~~~ + +.. automodule:: gcloud.storage.connection + :members: + :undoc-members: + :show-inheritance: From 54d28ecfc2fa6962d9c697985f9314a3de0814e8 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Wed, 5 Aug 2015 10:38:06 -0700 Subject: [PATCH 2/4] Folding in getting started doc into main index.rst. --- docs/_components/getting-started.rst | 32 --------------------------- docs/index.rst | 33 +++++++++++++++++++++++++++- 2 files changed, 32 insertions(+), 33 deletions(-) delete mode 100644 docs/_components/getting-started.rst diff --git a/docs/_components/getting-started.rst b/docs/_components/getting-started.rst deleted file mode 100644 index 477504bce66d..000000000000 --- a/docs/_components/getting-started.rst +++ /dev/null @@ -1,32 +0,0 @@ -The ``gcloud`` library is ``pip`` install-able: - -.. code-block:: console - - $ pip install gcloud - -If you have trouble installing -``pycrypto`` or ``pyopenssl`` -(and you're on Ubuntu), -you can try install the precompiled packages: - -.. code-block:: console - - $ sudo apt-get install python-crypto python-openssl - -If you want to install everything with ``pip``, -try installing the ``dev`` packages beforehand: - -.. code-block:: console - - $ sudo apt-get install python-dev libssl-dev - -If you want to install `gcloud-python` from source, -you can clone the repository from GitHub: - -.. code-block:: console - - $ git clone git://github.com/GoogleCloudPlatform/gcloud-python.git - $ cd gcloud-python - $ python setup.py install - ----- \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index efc37b3eed18..2959012dee5d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -48,7 +48,38 @@ Getting started --------------- -.. include:: _components/getting-started.rst +The ``gcloud`` library is ``pip`` install-able: + +.. code-block:: console + + $ pip install gcloud + +If you have trouble installing +``pycrypto`` or ``pyopenssl`` +(and you're on Ubuntu), +you can try install the precompiled packages: + +.. code-block:: console + + $ sudo apt-get install python-crypto python-openssl + +If you want to install everything with ``pip``, +try installing the ``dev`` packages beforehand: + +.. code-block:: console + + $ sudo apt-get install python-dev libssl-dev + +If you want to install `gcloud-python` from source, +you can clone the repository from GitHub: + +.. code-block:: console + + $ git clone git://github.com/GoogleCloudPlatform/gcloud-python.git + $ cd gcloud-python + $ python setup.py install + +---- Cloud Datastore ~~~~~~~~~~~~~~~ From bd8bcbc69861883ddc4e22bb1db8768e8a1665b8 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Wed, 5 Aug 2015 14:20:09 -0700 Subject: [PATCH 3/4] Removing unused components. --- docs/_components/creating-a-project.rst | 27 --- .../_components/datastore-getting-started.rst | 55 ----- .../enabling-a-service-account.rst | 41 ---- docs/_components/storage-getting-started.rst | 204 ------------------ docs/conf.py | 2 +- 5 files changed, 1 insertion(+), 328 deletions(-) delete mode 100644 docs/_components/creating-a-project.rst delete mode 100644 docs/_components/datastore-getting-started.rst delete mode 100644 docs/_components/enabling-a-service-account.rst delete mode 100644 docs/_components/storage-getting-started.rst diff --git a/docs/_components/creating-a-project.rst b/docs/_components/creating-a-project.rst deleted file mode 100644 index 04a94b3a0ba1..000000000000 --- a/docs/_components/creating-a-project.rst +++ /dev/null @@ -1,27 +0,0 @@ -* **Create a project** - - Start off by visiting https://cloud.google.com/console - and click on the big red button - that says "Create Project". - -* **Choose a name** - - In the box that says "name", - choose something friendly. - This is going to be the *human-readable* name - for your project. - -* **Choose an ID** - - In the box that says "ID", - choose something unique - (hyphens are OK). - I typically choose a project name - that starts with my initials, - then a hyphen, - then a unique identifier for the work I'm doing. - For this example, - you might choose ``-quickstart``. - -Then click OK -(give it a second to create your project). diff --git a/docs/_components/datastore-getting-started.rst b/docs/_components/datastore-getting-started.rst deleted file mode 100644 index 8ec592c2546d..000000000000 --- a/docs/_components/datastore-getting-started.rst +++ /dev/null @@ -1,55 +0,0 @@ -Getting started with Cloud Datastore -==================================== - -.. note:: - If you just want to kick the tires, - you might prefer :doc:`datastore-quickstart`. - -Creating a project ------------------- - -.. include:: _components/creating-a-project.rst - -Enabling the API ----------------- - -Now that you created a project, -you need to **turn on** the Cloud Datastore API. -This is sort of like telling Google -which services you intend to use for this project. - -* **Click on APIs & Auth** - on the left hand side, - and scroll down to where it says - "Google Cloud Datastore API". - -* **Click the "Off" button** - on the right side - to turn it into an "On" button. - -Enabling a service account --------------------------- - -.. include:: _components/enabling-a-service-account.rst - -Add some data to your dataset ------------------------------ - -Open a Python console and... - - >>> from gcloud import datastore - >>> list(datastore.Query(kind='Person').fetch()) - [] - >>> entity = datastore.Entity(key=datastore.Key('Person')) - >>> entity['name'] = 'Your name' - >>> entity['age'] = 25 - >>> datastore.put(entity) - >>> list(Query(kind='Person').fetch()) - [] - -And that's it! --------------- - -Next, -take a look at the complete -:doc:`datastore-api`. diff --git a/docs/_components/enabling-a-service-account.rst b/docs/_components/enabling-a-service-account.rst deleted file mode 100644 index e131f773046f..000000000000 --- a/docs/_components/enabling-a-service-account.rst +++ /dev/null @@ -1,41 +0,0 @@ -Now that you have a project, -we need to make sure we are able to access our data. -There are many ways to authenticate, -but we're going to use a Service Account for today. - -A *Service Account* is sort of like a username and password -(like when you're connecting to your MySQL database), -except the username is automatically generated -(and is an e-mail address) -and the password is actually a private key file. - -To create a Service Account: - -* **Click on Credentials** - under the "APIs & Auth" section. - -* **Click the big red button** - that says "Create New Client ID" - under the OAuth section - (the first one). - -* **Choose "Service Account"** - and click the blue button - that says "Create Client ID". - -* **This will automatically** - download a private key file. - **Do not lose this.** - -* **Rename your key** something shorter. - I like to name the key ``.p12``. - - This is like your password for the account. - -* **Copy the long weird e-mail address** - labeled "E-mail address" - in the information section - for the Service Account - you just created. - - This is like your username for the account. diff --git a/docs/_components/storage-getting-started.rst b/docs/_components/storage-getting-started.rst deleted file mode 100644 index 5d7527d472e9..000000000000 --- a/docs/_components/storage-getting-started.rst +++ /dev/null @@ -1,204 +0,0 @@ -Getting started with Cloud Storage -================================== - -This tutorial focuses on using ``gcloud`` to access Google Cloud Storage. -We'll go through the basic concepts, how to operate on buckets and blobs, -and how to handle access control, among other things. - -We're going to assume that you've already downloaded and installed the -library. - -Creating a project ------------------- - -.. include:: _components/creating-a-project.rst - -Enabling the API ----------------- - -Now that you created a project, you need to **turn on** the Google Cloud -Storage API. This is sort of like telling Google which services you intend -to use for this project. - -* **Click on APIs & Auth** on the left hand side, and scroll down to where -it says "Google Cloud Storage JSON API". - -* **Click the "Off" button** on the right side to turn it into an "On" -button. - -Enabling a service account --------------------------- - -.. include:: _components/enabling-a-service-account.rst - -Creating a connection ---------------------- - -The first step in accessing Cloud Storage is to create a connection to the -service:: - - >>> from gcloud import storage - >>> connection = storage.get_connection() - -We're going to use this :class:`connection -` object for the rest of this guide. - -Creating a bucket ------------------ - -Once you've established a connection to Cloud Storage, the first thing you -typically want to do is create a new bucket. A bucket is a container used -to store objects in Cloud Storage (if you're familiar with S3, buckets on -Cloud Storage mean the same thing). Think of each bucket as a single "disk -drive", where you can store lots of files on each. How you organize your -data is up to you, but it's typical to group common data in a single -bucket. - -Let's create a bucket: - - >>> bucket = client.create_bucket('test') - Traceback (most recent call last): - File "", line 1, in - File "gcloud/storage/connection.py", line 340, in create_bucket - data={'name': bucket.name}) - File "gcloud/storage/connection.py", line 324, in api_request - raise make_exception(response, content) - ... - -**Whoops!** - -It might be important to mention that bucket names are like domain names: -it's one big namespace that we all share, so you have to pick a bucket name -that isn't already taken. - -It's up to you to decide what a good name is, let's assume that you found a -unique name and are ready to move on with your newly created bucket. - -Storing data ------------- - -OK, so you have a bucket. Now what? Cloud Storage is just an arbitrary -data container, so you can put whatever format of data you want. The -naming of your files is also arbitrary, however the Cloud Storage online -file browser tries to make it feel a bit like a file system by recognizing -forward-slashes (``/``) so if you want to group data into "directories", -you can do that. - -The fundamental container for a file in Cloud Storage is called an Object, -however ``gcloud`` uses the term ``Blob`` to avoid confusion with the -Python built-in ``object``. - -If you want to set some data, you just create a ``Blob`` inside your bucket -and store your data inside the blob:: - - >>> blob = bucket.blob('greeting.txt') - >>> blob.upload_from_string('Hello world!') - -This creates a :class:`Blob ` object locally and -:func:`upload_from_string ` -allows you to put a string into the blob. - -Now we can test if it worked:: - - >>> blob = bucket.get_blob('greeting.txt') - >>> print blob.download_as_string() - Hello world! - -What if you want to save the contents to a file? - - >>> blob.download_to_file('greetings.txt') - -Then you can look at the file in a terminal:: - - $ cat greetings.txt - Hello world! - -And what about when you're not dealing with text? -That's pretty simple too:: - - >>> blob = bucket.blob('kitten.jpg') - >>> blob.upload_from_filename('kitten.jpg') - -And to test whether it worked? - - >>> blob = bucket.get_blob('kitten.jpg') - >>> blob.download_to_file('kitten2.jpg') - -and check if they are the same in a terminal:: - - $ diff kitten.jpg kitten2.jpg - -Notice that we're using :func:`get_blob -` to retrieve a blob we know exists -remotely. If the blob doesn't exist, it will return ``None``. - -.. note:: ``get_blob`` is **not** retrieving the entire object's data. - -If you want to "get-or-create" the blob (that is, overwrite it if it -already exists), you can just construct a :class:`gcloud.storage.blob.Blob` -locally and update it. However, keep in mind, the blob is not created -remotely until you store some data inside of it. - -If you want to check whether a blob exists, you can use the ``in`` operator -in Python:: - - >>> print 'kitten.jpg' in bucket - True - >>> print 'does-not-exist' in bucket - False - -Accessing a bucket ------------------- - -If you already have a bucket, use -:meth:`get_bucket ` to retrieve the -bucket object:: - - >>> bucket = client.get_bucket('my-bucket') - -If you want to get all the blobs in the bucket, you can use -:func:`list_blobs `:: - - >>> blobs = bucket.list_blobs() - -However, if you're looking to iterate through the blobs, you can use the -bucket itself as an iterator:: - - >>> for blob in bucket: - ... print blob - -Deleting a bucket ------------------ - -You can delete a bucket using the -:meth:`delete ` method:: - - >>> bucket.delete() - -Remember, the bucket you're deleting needs to be empty, otherwise you'll -get an error (409 conflict). - -If you have a full bucket, you can delete it this way:: - - >>> bucket.delete(force=True) - -Listing available buckets -------------------------- - - >>> for bucket in client.list_buckets(): - ... print bucket.name - -Managing access control ------------------------ - -Cloud storage provides fine-grained access control for both buckets and -blobs. `gcloud` tries to simplify access control by working with entities -and "grants". On any ACL, you get a reference to an entity, and then -either grant or revoke a specific access level. Additionally, we provide -two default entities: all users, and all authenticated users. - -For example, if you want to grant read access to all users on your bucket:: - - >>> bucket.get_acl().all().grant_read() - -For more detail on access control, see :mod:`gcloud.storage.acl`. diff --git a/docs/conf.py b/docs/conf.py index d39213a6a140..51b1de18cb09 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -82,7 +82,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build', '_components/*'] +exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None From f9427afe15803073046166616da78290b2d3b4c8 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Wed, 5 Aug 2015 14:30:53 -0700 Subject: [PATCH 4/4] Adding clarifying (by package) page titles where needed. Stilling preserving the short name in the toctree. Also adding trailing newlines to all .rst files that\ didn't have it (this was a side-effect of my editor, but not a bad one). --- docs/datastore-client.rst | 4 ++-- docs/datastore-entities.rst | 2 +- docs/datastore-keys.rst | 2 +- docs/datastore-queries.rst | 2 +- docs/datastore-transactions.rst | 2 +- docs/index.rst | 6 +++--- docs/pubsub-client.rst | 4 ++-- docs/storage-acl.rst | 2 +- docs/storage-buckets.rst | 2 +- docs/storage-client.rst | 4 ++-- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/datastore-client.rst b/docs/datastore-client.rst index a91e32b9a72a..bce60ef5052b 100644 --- a/docs/datastore-client.rst +++ b/docs/datastore-client.rst @@ -1,5 +1,5 @@ -Client -====== +Datastore Client +================ .. automodule:: gcloud.datastore.client :members: diff --git a/docs/datastore-entities.rst b/docs/datastore-entities.rst index 36b91179c173..119699fcb89e 100644 --- a/docs/datastore-entities.rst +++ b/docs/datastore-entities.rst @@ -4,4 +4,4 @@ Entities .. automodule:: gcloud.datastore.entity :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: diff --git a/docs/datastore-keys.rst b/docs/datastore-keys.rst index fa7e8b6f7cac..3567201a7101 100644 --- a/docs/datastore-keys.rst +++ b/docs/datastore-keys.rst @@ -4,4 +4,4 @@ Keys .. automodule:: gcloud.datastore.key :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: diff --git a/docs/datastore-queries.rst b/docs/datastore-queries.rst index 2870d510f0fd..1babc7c9661a 100644 --- a/docs/datastore-queries.rst +++ b/docs/datastore-queries.rst @@ -4,4 +4,4 @@ Queries .. automodule:: gcloud.datastore.query :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: diff --git a/docs/datastore-transactions.rst b/docs/datastore-transactions.rst index a17926413227..732283969403 100644 --- a/docs/datastore-transactions.rst +++ b/docs/datastore-transactions.rst @@ -4,4 +4,4 @@ Transactions .. automodule:: gcloud.datastore.transaction :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index 2959012dee5d..af050e3a6964 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,7 @@ :hidden: :caption: Datastore - datastore-client + Client datastore-entities datastore-keys datastore-queries @@ -22,7 +22,7 @@ :hidden: :caption: Storage - storage-client + Client storage-blobs storage-buckets storage-acl @@ -33,7 +33,7 @@ :caption: Pub/Sub pubsub-usage - pubsub-client + Client pubsub-topic pubsub-subscription diff --git a/docs/pubsub-client.rst b/docs/pubsub-client.rst index 3f8b64c7731b..f8b5dfefa491 100644 --- a/docs/pubsub-client.rst +++ b/docs/pubsub-client.rst @@ -1,5 +1,5 @@ -Client -======== +Pub/Sub Client +============== .. automodule:: gcloud.pubsub.client :members: diff --git a/docs/storage-acl.rst b/docs/storage-acl.rst index add41edb03a9..79fc6e4d2aea 100644 --- a/docs/storage-acl.rst +++ b/docs/storage-acl.rst @@ -4,4 +4,4 @@ ACL .. automodule:: gcloud.storage.acl :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: diff --git a/docs/storage-buckets.rst b/docs/storage-buckets.rst index f67a297a159d..55c19a461b93 100644 --- a/docs/storage-buckets.rst +++ b/docs/storage-buckets.rst @@ -4,4 +4,4 @@ Buckets .. automodule:: gcloud.storage.bucket :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: diff --git a/docs/storage-client.rst b/docs/storage-client.rst index 83bddb9dce0a..36eb4a21525d 100644 --- a/docs/storage-client.rst +++ b/docs/storage-client.rst @@ -1,5 +1,5 @@ -Client -====== +Storage Client +============== .. automodule:: gcloud.storage.client :members: