Skip to content

Commit 27da413

Browse files
committed
Updating included docs and ignoring some that need not be public.
Also making sure `tox -e docs` **always** gets run in update_docs.sh, to verify the docs build successfully at all times.
1 parent 5c90953 commit 27da413

File tree

7 files changed

+42
-1
lines changed

7 files changed

+42
-1
lines changed

docs/bigquery-query.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Query
2+
~~~~~
3+
4+
.. automodule:: gcloud.bigquery.query
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/datastore-helpers.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Helpers
2+
~~~~~~~
3+
4+
.. automodule:: gcloud.datastore.helpers
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/gcloud-api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,11 @@ Exceptions
3333
:members:
3434
:undoc-members:
3535
:show-inheritance:
36+
37+
Environment Variables
38+
~~~~~~~~~~~~~~~~~~~~~
39+
40+
.. automodule:: gcloud.environment_vars
41+
:members:
42+
:undoc-members:
43+
:show-inheritance:

docs/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
datastore-queries
1818
datastore-transactions
1919
datastore-batches
20+
datastore-helpers
2021

2122
.. toctree::
2223
:maxdepth: 0
@@ -27,6 +28,7 @@
2728
storage-blobs
2829
storage-buckets
2930
storage-acl
31+
storage-batch
3032

3133
.. toctree::
3234
:maxdepth: 0
@@ -49,6 +51,7 @@
4951
bigquery-dataset
5052
bigquery-job
5153
bigquery-table
54+
bigquery-query
5255

5356
.. toctree::
5457
:maxdepth: 0

docs/storage-batch.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Batches
2+
~~~~~~~
3+
4+
.. automodule:: gcloud.storage.batch
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

scripts/update_docs.sh

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ if [[ "${TRAVIS_BRANCH}" == "master" ]] && \
2525
elif [[ -n "${TRAVIS_TAG}" ]]; then
2626
echo "Building new docs on a tag."
2727
else
28-
echo "Not on Travis, doing nothing."
28+
echo "No docs to update for a new tag or merged commit on Travis."
29+
echo "Verifying docs build successfully."
30+
tox -e docs
2931
exit
3032
fi
3133

scripts/verify_included_modules.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,14 @@
3838
'gcloud.bigtable.table',
3939
'gcloud.datastore.demo.demo',
4040
'gcloud.demo',
41+
'gcloud.iterator',
4142
'gcloud.storage.demo.demo',
43+
'gcloud.streaming.buffered_stream',
44+
'gcloud.streaming.exceptions',
45+
'gcloud.streaming.http_wrapper',
46+
'gcloud.streaming.stream_slice',
47+
'gcloud.streaming.transfer',
48+
'gcloud.streaming.util',
4249
])
4350

4451

0 commit comments

Comments
 (0)