Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drop ':undoc-members:' from Sphinx API docs #1804

Merged
merged 2 commits into from
May 17, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/bigquery-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@ BigQuery Client

.. automodule:: gcloud.bigquery.client
:members:
:undoc-members:
:show-inheritance:

Connection
~~~~~~~~~~

.. automodule:: gcloud.bigquery.connection
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/bigquery-dataset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Datasets

.. automodule:: gcloud.bigquery.dataset
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/bigquery-job.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Jobs

.. automodule:: gcloud.bigquery.job
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/bigquery-query.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Query

.. automodule:: gcloud.bigquery.query
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/bigquery-table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Tables

.. automodule:: gcloud.bigquery.table
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/bigtable-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Client

.. automodule:: gcloud.bigtable.client
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/bigtable-cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Cluster

.. automodule:: gcloud.bigtable.cluster
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/bigtable-column-family.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,4 @@ at the lowest level of the nesting:

.. automodule:: gcloud.bigtable.column_family
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/bigtable-row-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Row Data

.. automodule:: gcloud.bigtable.row_data
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/bigtable-row-filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ level. For example:

.. automodule:: gcloud.bigtable.row_filters
:members:
:undoc-members:
:show-inheritance:

.. _RowFilter definition: https://github.com/GoogleCloudPlatform/cloud-bigtable-client/blob/1ff247c2e3b7cd0a2dd49071b2d95beaf6563092/bigtable-protos/src/main/proto/google/bigtable/v1/bigtable_data.proto#L195
1 change: 0 additions & 1 deletion docs/bigtable-row.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ Bigtable Row

.. automodule:: gcloud.bigtable.row
:members:
:undoc-members:
:show-inheritance:
:inherited-members:
1 change: 0 additions & 1 deletion docs/bigtable-table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Table

.. automodule:: gcloud.bigtable.table
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/datastore-batches.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Batches

.. automodule:: gcloud.datastore.batch
:members:
:undoc-members:
:show-inheritance:
2 changes: 0 additions & 2 deletions docs/datastore-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@ Datastore Client

.. automodule:: gcloud.datastore.client
:members:
:undoc-members:
:show-inheritance:

Connection
~~~~~~~~~~

.. automodule:: gcloud.datastore.connection
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/datastore-entities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Entities

.. automodule:: gcloud.datastore.entity
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/datastore-helpers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Helpers

.. automodule:: gcloud.datastore.helpers
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/datastore-keys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Keys

.. automodule:: gcloud.datastore.key
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/datastore-queries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Queries

.. automodule:: gcloud.datastore.query
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/datastore-transactions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ Transactions

.. automodule:: gcloud.datastore.transaction
:members:
:undoc-members:
:show-inheritance:
:inherited-members:
1 change: 0 additions & 1 deletion docs/dns-changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Change Sets

.. automodule:: gcloud.dns.changes
:members:
:undoc-members:
:show-inheritance:
2 changes: 0 additions & 2 deletions docs/dns-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@ DNS Client

.. automodule:: gcloud.dns.client
:members:
:undoc-members:
:show-inheritance:

Connection
~~~~~~~~~~

.. automodule:: gcloud.dns.connection
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/dns-resource-record-set.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Resource Record Sets

.. automodule:: gcloud.dns.resource_record_set
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/dns-zone.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Managed Zones

.. automodule:: gcloud.dns.zone
:members:
:undoc-members:
:show-inheritance:
5 changes: 0 additions & 5 deletions docs/gcloud-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Base Client

.. automodule:: gcloud.client
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

Expand All @@ -15,29 +14,25 @@ Credentials Helpers

.. automodule:: gcloud.credentials
:members:
:undoc-members:
:show-inheritance:

Base Connections
~~~~~~~~~~~~~~~~

.. automodule:: gcloud.connection
:members:
:undoc-members:
:show-inheritance:

Exceptions
~~~~~~~~~~

.. automodule:: gcloud.exceptions
:members:
:undoc-members:
:show-inheritance:

Environment Variables
~~~~~~~~~~~~~~~~~~~~~

.. automodule:: gcloud.environment_vars
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/happybase-batch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ HappyBase Batch

.. automodule:: gcloud.bigtable.happybase.batch
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/happybase-connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ HappyBase Connection

.. automodule:: gcloud.bigtable.happybase.connection
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/happybase-package.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ HappyBase Package

.. automodule:: gcloud.bigtable.happybase.__init__
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/happybase-pool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ HappyBase Connection Pool

.. automodule:: gcloud.bigtable.happybase.pool
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/happybase-table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ HappyBase Table

.. automodule:: gcloud.bigtable.happybase.table
:members:
:undoc-members:
:show-inheritance:
2 changes: 0 additions & 2 deletions docs/logging-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@ Logging Client

.. automodule:: gcloud.logging.client
:members:
:undoc-members:
:show-inheritance:

Connection
~~~~~~~~~~

.. automodule:: gcloud.logging.connection
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/logging-entries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ Entries

.. automodule:: gcloud.logging.entries
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/logging-logger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ Logger

.. automodule:: gcloud.logging.logger
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/logging-metric.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Metrics

.. automodule:: gcloud.logging.metric
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/logging-sink.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Sinks

.. automodule:: gcloud.logging.sink
:members:
:undoc-members:
:show-inheritance:
2 changes: 0 additions & 2 deletions docs/monitoring-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@ Monitoring Client

.. automodule:: gcloud.monitoring.client
:members:
:undoc-members:
:show-inheritance:

Connection
~~~~~~~~~~

.. automodule:: gcloud.monitoring.connection
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/monitoring-label.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Label Descriptors

.. automodule:: gcloud.monitoring.label
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/monitoring-metric.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Metric Descriptors

.. automodule:: gcloud.monitoring.metric
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/monitoring-query.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Time Series Query

.. automodule:: gcloud.monitoring.query
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/monitoring-resource.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Monitored Resource Descriptors

.. automodule:: gcloud.monitoring.resource
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/monitoring-timeseries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Time Series

.. automodule:: gcloud.monitoring.timeseries
:members:
:undoc-members:
:show-inheritance:
2 changes: 0 additions & 2 deletions docs/pubsub-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@ Pub/Sub Client

.. automodule:: gcloud.pubsub.client
:members:
:undoc-members:
:show-inheritance:

Connection
~~~~~~~~~~

.. automodule:: gcloud.pubsub.connection
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/pubsub-iam.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@ IAM Policy
.. automodule:: gcloud.pubsub.iam
:members:
:member-order: bysource
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/pubsub-message.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Message

.. automodule:: gcloud.pubsub.message
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/pubsub-subscription.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Subscriptions
.. automodule:: gcloud.pubsub.subscription
:members:
:member-order: bysource
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/pubsub-topic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Topics
.. automodule:: gcloud.pubsub.topic
:members:
:member-order: bysource
:undoc-members:
:show-inheritance:
2 changes: 0 additions & 2 deletions docs/resource-manager-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,11 @@ Client

.. automodule:: gcloud.resource_manager.client
:members:
:undoc-members:
:show-inheritance:

Connection
~~~~~~~~~~

.. automodule:: gcloud.resource_manager.connection
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/resource-manager-project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Projects

.. automodule:: gcloud.resource_manager.project
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/storage-acl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ ACL

.. automodule:: gcloud.storage.acl
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/storage-batch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Batches

.. automodule:: gcloud.storage.batch
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/storage-blobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Blobs / Objects

.. automodule:: gcloud.storage.blob
:members:
:undoc-members:
:show-inheritance:
Loading