From 22e4c630458dd5eb198fbfea493238789e6f7962 Mon Sep 17 00:00:00 2001 From: Tres Seaver Date: Thu, 14 May 2015 17:00:21 -0400 Subject: [PATCH 1/2] Improve autodocs for top-level package names. - Drop the '__init__' from them. - Include the ones imported from '_implicit_environ'. Fixes #845. --- docs/datastore-api.rst | 7 +++---- docs/pubsub-api.rst | 7 +++---- docs/storage-api.rst | 7 +++---- 3 files changed, 9 insertions(+), 12 deletions(-) diff --git a/docs/datastore-api.rst b/docs/datastore-api.rst index 16aabfabb534..536aa039ba18 100644 --- a/docs/datastore-api.rst +++ b/docs/datastore-api.rst @@ -10,10 +10,9 @@ Datastore :mod:`gcloud.datastore` ~~~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: gcloud.datastore.__init__ - :members: - :undoc-members: - :show-inheritance: +.. automodule:: gcloud.datastore + :members: get_connection, get_default_connection, get_default_dataset_id, + set_default_connection, set_default_dataset_id, set_defaults Connections ~~~~~~~~~~~ diff --git a/docs/pubsub-api.rst b/docs/pubsub-api.rst index 2f6e609b6526..0346bd1b09dc 100644 --- a/docs/pubsub-api.rst +++ b/docs/pubsub-api.rst @@ -8,10 +8,9 @@ Pub/Sub :mod:`gcloud.pubsub` ~~~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: gcloud.pubsub.__init__ - :members: - :undoc-members: - :show-inheritance: +.. automodule:: gcloud.pubsub + :members: get_connection, get_default_connection, + set_default_connection, set_defaults Connections ~~~~~~~~~~~ diff --git a/docs/storage-api.rst b/docs/storage-api.rst index b3fc4cc661d5..6cbced11a7f6 100644 --- a/docs/storage-api.rst +++ b/docs/storage-api.rst @@ -10,10 +10,9 @@ Storage :mod:`gcloud.storage` ~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: gcloud.storage.__init__ - :members: - :undoc-members: - :show-inheritance: +.. automodule:: gcloud.storage + :members: get_connection, get_default_connection, get_default_bucket, + set_default_connection, set_default_bucket, set_defaults Connections ~~~~~~~~~~~ From fbba1c4755022810b45a348ce1822ae275646d3d Mon Sep 17 00:00:00 2001 From: Tres Seaver Date: Thu, 14 May 2015 17:20:25 -0400 Subject: [PATCH 2/2] Fix bullet rendering. Addresses: https://github.com/GoogleCloudPlatform/gcloud-python/pull/882#issuecomment-102170074. --- gcloud/datastore/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/gcloud/datastore/__init__.py b/gcloud/datastore/__init__.py index f5bfa7de4cc4..b8b8ba9b1344 100644 --- a/gcloud/datastore/__init__.py +++ b/gcloud/datastore/__init__.py @@ -71,10 +71,12 @@ def set_defaults(dataset_id=None, connection=None): """Set defaults either explicitly or implicitly as fall-back. Uses the arguments to call the individual default methods + - set_default_dataset_id - set_default_connection In the future we will likely enable methods like + - set_default_namespace :type dataset_id: string