Skip to content

Commit

Permalink
docs: fix documentation structure (#949)
Browse files Browse the repository at this point in the history
Co-authored-by: Astha Mohta <[email protected]>
  • Loading branch information
dandhlee and asthamohta committed Jul 6, 2023
1 parent 7e2e712 commit b73e47b
Show file tree
Hide file tree
Showing 16 changed files with 34 additions and 47 deletions.
34 changes: 0 additions & 34 deletions docs/api-reference.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/client-usage.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Spanner Client
==============
Spanner Client Usage
====================

.. _spanner-client:

Expand Down
4 changes: 2 additions & 2 deletions docs/database-usage.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
31 changes: 26 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------

Expand Down
4 changes: 2 additions & 2 deletions docs/instance-usage.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/table-usage.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit b73e47b

Please sign in to comment.