diff --git a/docs/api-reference.rst b/docs/api-reference.rst deleted file mode 100644 index 41046f78bf..0000000000 --- a/docs/api-reference.rst +++ /dev/null @@ -1,34 +0,0 @@ -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 - table-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 - - spanner_v1/services - spanner_v1/types - spanner_admin_database_v1/services - spanner_admin_database_v1/types - spanner_admin_instance_v1/services - spanner_admin_instance_v1/types diff --git a/docs/client-usage.rst b/docs/client-usage.rst index ce13bf4aa0..7ba3390e59 100644 --- a/docs/client-usage.rst +++ b/docs/client-usage.rst @@ -1,5 +1,5 @@ -Spanner Client -============== +Spanner Client Usage +==================== .. _spanner-client: diff --git a/docs/database-usage.rst b/docs/database-usage.rst index 629f1ab28a..afcfa06cb2 100644 --- a/docs/database-usage.rst +++ b/docs/database-usage.rst @@ -1,5 +1,5 @@ -Database Admin -============== +Database Admin Usage +==================== After creating an :class:`~google.cloud.spanner_v1.instance.Instance`, you can interact with individual databases for that instance. diff --git a/docs/index.rst b/docs/index.rst index a4ab1b27d7..0e7f24d6e7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,27 +5,48 @@ Usage Documentation ------------------- .. toctree:: - :maxdepth: 1 - :titlesonly: + :maxdepth: 2 client-usage - instance-usage - database-usage table-usage batch-usage snapshot-usage transaction-usage + database-usage + instance-usage + API Documentation ----------------- .. toctree:: :maxdepth: 1 :titlesonly: - api-reference advanced-session-pool-topics opentelemetry-tracing + spanner_v1/client + spanner_v1/instance + spanner_v1/database + spanner_v1/table + spanner_v1/session + spanner_v1/keyset + spanner_v1/snapshot + spanner_v1/batch + spanner_v1/transaction + spanner_v1/streamed + + spanner_v1/services + spanner_v1/types + spanner_admin_database_v1/services + spanner_admin_database_v1/types + spanner_admin_database_v1/database_admin + spanner_admin_instance_v1/services + spanner_admin_instance_v1/types + spanner_admin_instance_v1/instance_admin + + + Changelog --------- diff --git a/docs/instance-usage.rst b/docs/instance-usage.rst index 55042c2df3..b45b69acc6 100644 --- a/docs/instance-usage.rst +++ b/docs/instance-usage.rst @@ -1,5 +1,5 @@ -Instance Admin -============== +Instance Admin Usage +==================== After creating a :class:`~google.cloud.spanner_v1.client.Client`, you can interact with individual instances for a project. diff --git a/docs/batch-api.rst b/docs/spanner_v1/batch.rst similarity index 100% rename from docs/batch-api.rst rename to docs/spanner_v1/batch.rst diff --git a/docs/client-api.rst b/docs/spanner_v1/client.rst similarity index 100% rename from docs/client-api.rst rename to docs/spanner_v1/client.rst diff --git a/docs/database-api.rst b/docs/spanner_v1/database.rst similarity index 100% rename from docs/database-api.rst rename to docs/spanner_v1/database.rst diff --git a/docs/instance-api.rst b/docs/spanner_v1/instance.rst similarity index 100% rename from docs/instance-api.rst rename to docs/spanner_v1/instance.rst diff --git a/docs/keyset-api.rst b/docs/spanner_v1/keyset.rst similarity index 100% rename from docs/keyset-api.rst rename to docs/spanner_v1/keyset.rst diff --git a/docs/session-api.rst b/docs/spanner_v1/session.rst similarity index 100% rename from docs/session-api.rst rename to docs/spanner_v1/session.rst diff --git a/docs/snapshot-api.rst b/docs/spanner_v1/snapshot.rst similarity index 100% rename from docs/snapshot-api.rst rename to docs/spanner_v1/snapshot.rst diff --git a/docs/streamed-api.rst b/docs/spanner_v1/streamed.rst similarity index 100% rename from docs/streamed-api.rst rename to docs/spanner_v1/streamed.rst diff --git a/docs/table-api.rst b/docs/spanner_v1/table.rst similarity index 100% rename from docs/table-api.rst rename to docs/spanner_v1/table.rst diff --git a/docs/transaction-api.rst b/docs/spanner_v1/transaction.rst similarity index 100% rename from docs/transaction-api.rst rename to docs/spanner_v1/transaction.rst diff --git a/docs/table-usage.rst b/docs/table-usage.rst index 9d28da1ebb..01459b5f8e 100644 --- a/docs/table-usage.rst +++ b/docs/table-usage.rst @@ -1,5 +1,5 @@ -Table Admin -=========== +Table Admin Usage +================= After creating an :class:`~google.cloud.spanner_v1.database.Database`, you can interact with individual tables for that instance.