Skip to content

Commit b73e47b

Browse files
dandhleeasthamohta
andauthored
docs: fix documentation structure (#949)
Co-authored-by: Astha Mohta <35952883+asthamohta@users.noreply.github.com>
1 parent 7e2e712 commit b73e47b

16 files changed

+34
-47
lines changed

‎docs/api-reference.rst

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎docs/client-usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Spanner Client
2-
==============
1+
Spanner Client Usage
2+
====================
33

44
.. _spanner-client:
55

‎docs/database-usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Database Admin
2-
==============
1+
Database Admin Usage
2+
====================
33

44
After creating an :class:`~google.cloud.spanner_v1.instance.Instance`, you can
55
interact with individual databases for that instance.

‎docs/index.rst

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,48 @@
55
Usage Documentation
66
-------------------
77
.. toctree::
8-
:maxdepth: 1
9-
:titlesonly:
8+
:maxdepth: 2
109

1110
client-usage
12-
instance-usage
13-
database-usage
1411
table-usage
1512
batch-usage
1613
snapshot-usage
1714
transaction-usage
1815

16+
database-usage
17+
instance-usage
18+
1919
API Documentation
2020
-----------------
2121
.. toctree::
2222
:maxdepth: 1
2323
:titlesonly:
2424

25-
api-reference
2625
advanced-session-pool-topics
2726
opentelemetry-tracing
2827

28+
spanner_v1/client
29+
spanner_v1/instance
30+
spanner_v1/database
31+
spanner_v1/table
32+
spanner_v1/session
33+
spanner_v1/keyset
34+
spanner_v1/snapshot
35+
spanner_v1/batch
36+
spanner_v1/transaction
37+
spanner_v1/streamed
38+
39+
spanner_v1/services
40+
spanner_v1/types
41+
spanner_admin_database_v1/services
42+
spanner_admin_database_v1/types
43+
spanner_admin_database_v1/database_admin
44+
spanner_admin_instance_v1/services
45+
spanner_admin_instance_v1/types
46+
spanner_admin_instance_v1/instance_admin
47+
48+
49+
2950
Changelog
3051
---------
3152

‎docs/instance-usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Instance Admin
2-
==============
1+
Instance Admin Usage
2+
====================
33

44
After creating a :class:`~google.cloud.spanner_v1.client.Client`, you can
55
interact with individual instances for a project.
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.

‎docs/table-usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Table Admin
2-
===========
1+
Table Admin Usage
2+
=================
33

44
After creating an :class:`~google.cloud.spanner_v1.database.Database`, you can
55
interact with individual tables for that instance.

0 commit comments

Comments
 (0)