Skip to content

Commit

Permalink
Fix up the documentation nav for Spanner. (#4054)
Browse files Browse the repository at this point in the history
  • Loading branch information
lukesneeringer authored Sep 25, 2017
1 parent 4c084cf commit 2459682
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 21 deletions.
33 changes: 33 additions & 0 deletions docs/spanner/api-reference.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
API Reference
=============

The following classes and methods constitute the Spanner client.
Most likely, you will be interacting almost exclusively with these:

.. toctree::
:maxdepth: 1

client-api
instance-api
database-api
session-api
keyset-api
snapshot-api
batch-api
transaction-api
streamed-api


The classes and methods above depend on the following, lower-level
classes and methods. Documentation for these is provided for completion,
and some advanced use cases may wish to interact with these directly:

.. toctree::
:maxdepth: 1

gapic/v1/api
gapic/v1/types
gapic/v1/admin_database_api
gapic/v1/admin_database_types
gapic/v1/admin_instance_api
gapic/v1/admin_instance_types
4 changes: 2 additions & 2 deletions docs/spanner/database-usage.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Database Admin API
==================
Database Admin
==============

After creating a :class:`~google.cloud.spanner.instance.Instance`, you can
interact with individual databases for that instance.
Expand Down
4 changes: 2 additions & 2 deletions docs/spanner/instance-usage.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Instance Admin API
==================
Instance Admin
==============

After creating a :class:`~google.cloud.spanner.client.Client`, you can
interact with individual instances for a project.
Expand Down
18 changes: 1 addition & 17 deletions docs/spanner/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,7 @@ Spanner
snapshot-usage
transaction-usage
advanced-session-pool-topics

client-api
instance-api
database-api
session-api
keyset-api
snapshot-api
batch-api
transaction-api
streamed-api

gapic/v1/api
gapic/v1/types
gapic/v1/admin_database_api
gapic/v1/admin_database_types
gapic/v1/admin_instance_api
gapic/v1/admin_instance_types
api-reference

API requests are sent to the `Cloud Spanner`_ API via RPC over
HTTP/2. In order to support this, we'll rely on `gRPC`_.
Expand Down

0 comments on commit 2459682

Please sign in to comment.