Adding undocumented modules to Sphinx.

Missing: - gcloud.__init__ - gcloud.connection - gcloud.credential - gcloud.datastore.api
googleapis · Jan 15, 2015 · 2529b69 · 2529b69
1 parent d922f1d
commit 2529b69
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 3 deletions.
diff --git a/docs/datastore-api.rst b/docs/datastore-api.rst
@@ -23,8 +23,16 @@ Connections
   :undoc-members:
   :show-inheritance:
 
+Interacting with the API
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: gcloud.datastore.api
+  :members:
+  :undoc-members:
+  :show-inheritance:
+
 Helper functions
 ~~~~~~~~~~~~~~~~
 
 .. automodule:: gcloud.datastore.helpers
-  :members:
+  :members:
diff --git a/docs/gcloud-api.rst b/docs/gcloud-api.rst
@@ -0,0 +1,30 @@
+.. toctree::
+  :maxdepth: 1
+  :hidden:
+
+GCloud Package
+--------------
+
+:mod:`gcloud`
+~~~~~~~~~~~~~
+
+.. automodule:: gcloud.__init__
+  :members:
+  :undoc-members:
+  :show-inheritance:
+
+Connections
+~~~~~~~~~~~
+
+.. automodule:: gcloud.connection
+  :members:
+  :undoc-members:
+  :show-inheritance:
+
+Credentials
+~~~~~~~~~~~
+
+.. automodule:: gcloud.credentials
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,6 +2,7 @@
   :maxdepth: 0
   :hidden:
 
+  gcloud-api
   datastore-api
   datastore-entities
   datastore-keys

diff --git a/gcloud/credentials.py b/gcloud/credentials.py
@@ -27,8 +27,7 @@ def get_credentials():
 
     Checks environment in order of precedence:
     - Google App Engine (production and testing)
-    - Environment variable GOOGLE_APPLICATION_CREDENTIALS pointing to
-      a file with stored credentials information.
+    - Env. var. GOOGLE_APPLICATION_CREDENTIALS pointing to stored credentials.
     - Stored "well known" file associated with ``gcloud`` command line tool.
     - Google Compute Engine production environment.