From 1f4508d63ec60f288d3615e0fc9cad3576def714 Mon Sep 17 00:00:00 2001 From: Dan Lee Date: Wed, 8 May 2024 06:40:53 +0000 Subject: [PATCH] docs: move rst files around --- docs/async_data_row_filters.rst | 6 ----- docs/async_data_usage.rst | 14 ----------- docs/{ => bigtable}/app-profile.rst | 0 docs/{ => bigtable}/async_data_client.rst | 0 docs/{ => bigtable}/async_data_exceptions.rst | 0 docs/{ => bigtable}/async_data_mutations.rst | 0 .../async_data_mutations_batcher.rst | 0 .../async_data_read_modify_write_rules.rst | 0 .../async_data_read_rows_query.rst | 0 docs/{ => bigtable}/async_data_row.rst | 0 docs/{ => bigtable}/backup.rst | 0 docs/{ => bigtable}/batcher.rst | 0 docs/{ => bigtable}/client.rst | 0 docs/{ => bigtable}/cluster.rst | 0 docs/bigtable/column_family.rst | 5 ++++ docs/bigtable/data_row_filters.rst | 5 ++++ docs/{ => bigtable}/encryption-info.rst | 0 docs/{ => bigtable}/instance.rst | 0 docs/{ => bigtable}/row-data.rst | 0 docs/{ => bigtable}/row-set.rst | 0 docs/{ => bigtable}/row.rst | 0 .../row_filters.rst} | 0 docs/{ => bigtable}/snippets.py | 0 docs/{ => bigtable}/snippets_table.py | 0 docs/{ => bigtable}/table.rst | 0 docs/column-family.rst | 6 ----- docs/index.rst | 25 ++++++++++++++++++- docs/usage.rst | 14 ----------- 28 files changed, 34 insertions(+), 41 deletions(-) delete mode 100644 docs/async_data_usage.rst rename docs/{ => bigtable}/app-profile.rst (100%) rename docs/{ => bigtable}/async_data_client.rst (100%) rename docs/{ => bigtable}/async_data_exceptions.rst (100%) rename docs/{ => bigtable}/async_data_mutations.rst (100%) rename docs/{ => bigtable}/async_data_mutations_batcher.rst (100%) rename docs/{ => bigtable}/async_data_read_modify_write_rules.rst (100%) rename docs/{ => bigtable}/async_data_read_rows_query.rst (100%) rename docs/{ => bigtable}/async_data_row.rst (100%) rename docs/{ => bigtable}/backup.rst (100%) rename docs/{ => bigtable}/batcher.rst (100%) rename docs/{ => bigtable}/client.rst (100%) rename docs/{ => bigtable}/cluster.rst (100%) create mode 100644 docs/bigtable/column_family.rst create mode 100644 docs/bigtable/data_row_filters.rst rename docs/{ => bigtable}/encryption-info.rst (100%) rename docs/{ => bigtable}/instance.rst (100%) rename docs/{ => bigtable}/row-data.rst (100%) rename docs/{ => bigtable}/row-set.rst (100%) rename docs/{ => bigtable}/row.rst (100%) rename docs/{row-filters.rst => bigtable/row_filters.rst} (100%) rename docs/{ => bigtable}/snippets.py (100%) rename docs/{ => bigtable}/snippets_table.py (100%) rename docs/{ => bigtable}/table.rst (100%) diff --git a/docs/async_data_row_filters.rst b/docs/async_data_row_filters.rst index 22bda8a26..84c5bdd7b 100644 --- a/docs/async_data_row_filters.rst +++ b/docs/async_data_row_filters.rst @@ -54,9 +54,3 @@ level. For example: # Bring our two labeled columns together. row_filter = RowFilterUnion(filters=[chain1, chain2]) - ----- - -.. automodule:: google.cloud.bigtable.data.row_filters - :members: - :show-inheritance: diff --git a/docs/async_data_usage.rst b/docs/async_data_usage.rst deleted file mode 100644 index c436c5988..000000000 --- a/docs/async_data_usage.rst +++ /dev/null @@ -1,14 +0,0 @@ -Using the Async Data Client -=========================== - -.. toctree:: - :maxdepth: 2 - - async_data_client - async_data_mutations_batcher - async_data_read_rows_query - async_data_row - async_data_row_filters - async_data_mutations - async_data_read_modify_write_rules - async_data_exceptions diff --git a/docs/app-profile.rst b/docs/bigtable/app-profile.rst similarity index 100% rename from docs/app-profile.rst rename to docs/bigtable/app-profile.rst diff --git a/docs/async_data_client.rst b/docs/bigtable/async_data_client.rst similarity index 100% rename from docs/async_data_client.rst rename to docs/bigtable/async_data_client.rst diff --git a/docs/async_data_exceptions.rst b/docs/bigtable/async_data_exceptions.rst similarity index 100% rename from docs/async_data_exceptions.rst rename to docs/bigtable/async_data_exceptions.rst diff --git a/docs/async_data_mutations.rst b/docs/bigtable/async_data_mutations.rst similarity index 100% rename from docs/async_data_mutations.rst rename to docs/bigtable/async_data_mutations.rst diff --git a/docs/async_data_mutations_batcher.rst b/docs/bigtable/async_data_mutations_batcher.rst similarity index 100% rename from docs/async_data_mutations_batcher.rst rename to docs/bigtable/async_data_mutations_batcher.rst diff --git a/docs/async_data_read_modify_write_rules.rst b/docs/bigtable/async_data_read_modify_write_rules.rst similarity index 100% rename from docs/async_data_read_modify_write_rules.rst rename to docs/bigtable/async_data_read_modify_write_rules.rst diff --git a/docs/async_data_read_rows_query.rst b/docs/bigtable/async_data_read_rows_query.rst similarity index 100% rename from docs/async_data_read_rows_query.rst rename to docs/bigtable/async_data_read_rows_query.rst diff --git a/docs/async_data_row.rst b/docs/bigtable/async_data_row.rst similarity index 100% rename from docs/async_data_row.rst rename to docs/bigtable/async_data_row.rst diff --git a/docs/backup.rst b/docs/bigtable/backup.rst similarity index 100% rename from docs/backup.rst rename to docs/bigtable/backup.rst diff --git a/docs/batcher.rst b/docs/bigtable/batcher.rst similarity index 100% rename from docs/batcher.rst rename to docs/bigtable/batcher.rst diff --git a/docs/client.rst b/docs/bigtable/client.rst similarity index 100% rename from docs/client.rst rename to docs/bigtable/client.rst diff --git a/docs/cluster.rst b/docs/bigtable/cluster.rst similarity index 100% rename from docs/cluster.rst rename to docs/bigtable/cluster.rst diff --git a/docs/bigtable/column_family.rst b/docs/bigtable/column_family.rst new file mode 100644 index 000000000..5c25fd0fb --- /dev/null +++ b/docs/bigtable/column_family.rst @@ -0,0 +1,5 @@ +Column Family +------------- +.. automodule:: google.cloud.bigtable.column_family + :members: + :show-inheritance: diff --git a/docs/bigtable/data_row_filters.rst b/docs/bigtable/data_row_filters.rst new file mode 100644 index 000000000..333b984d8 --- /dev/null +++ b/docs/bigtable/data_row_filters.rst @@ -0,0 +1,5 @@ +Row Filters +----------- +.. automodule:: google.cloud.bigtable.data.row_filters + :members: + :show-inheritance: diff --git a/docs/encryption-info.rst b/docs/bigtable/encryption-info.rst similarity index 100% rename from docs/encryption-info.rst rename to docs/bigtable/encryption-info.rst diff --git a/docs/instance.rst b/docs/bigtable/instance.rst similarity index 100% rename from docs/instance.rst rename to docs/bigtable/instance.rst diff --git a/docs/row-data.rst b/docs/bigtable/row-data.rst similarity index 100% rename from docs/row-data.rst rename to docs/bigtable/row-data.rst diff --git a/docs/row-set.rst b/docs/bigtable/row-set.rst similarity index 100% rename from docs/row-set.rst rename to docs/bigtable/row-set.rst diff --git a/docs/row.rst b/docs/bigtable/row.rst similarity index 100% rename from docs/row.rst rename to docs/bigtable/row.rst diff --git a/docs/row-filters.rst b/docs/bigtable/row_filters.rst similarity index 100% rename from docs/row-filters.rst rename to docs/bigtable/row_filters.rst diff --git a/docs/snippets.py b/docs/bigtable/snippets.py similarity index 100% rename from docs/snippets.py rename to docs/bigtable/snippets.py diff --git a/docs/snippets_table.py b/docs/bigtable/snippets_table.py similarity index 100% rename from docs/snippets_table.py rename to docs/bigtable/snippets_table.py diff --git a/docs/table.rst b/docs/bigtable/table.rst similarity index 100% rename from docs/table.rst rename to docs/bigtable/table.rst diff --git a/docs/column-family.rst b/docs/column-family.rst index de6c1eb1f..e68bc6902 100644 --- a/docs/column-family.rst +++ b/docs/column-family.rst @@ -41,9 +41,3 @@ at the lowest level of the nesting: # **OR** anything that has more than 3 versions. rule4 = GarbageCollectionRule(max_num_versions=3) rule5 = GarbageCollectionUnion(rules=[rule3, rule4]) - ----- - -.. automodule:: google.cloud.bigtable.column_family - :members: - :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index 0f04542cc..0d4fdb51f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,8 @@ Using the API :maxdepth: 2 usage - async_data_usage + column-family + async_data_row_filters API Reference @@ -20,6 +21,28 @@ API Reference table-api data-api + bigtable/app-profile.rst + bigtable/async_data_client.rst + bigtable/async_data_exceptions.rst + bigtable/async_data_mutations_batcher.rst + bigtable/async_data_mutations.rst + bigtable/async_data_read_modify_write_rules.rst + bigtable/async_data_read_rows_query.rst + bigtable/async_data_row.rst + bigtable/backup.rst + bigtable/batcher.rst + bigtable/client.rst + bigtable/cluster.rst + bigtable/column_family.rst + bigtable/data_row_filters.rst + bigtable/encryption-info.rst + bigtable/instance.rst + bigtable/row-data.rst + bigtable/row_filters.rst + bigtable/row.rst + bigtable/row-set.rst + bigtable/table.rst + Changelog --------- diff --git a/docs/usage.rst b/docs/usage.rst index de0abac9c..fcd5798bd 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -5,20 +5,6 @@ Using the Sync Client :maxdepth: 2 client-intro - client - cluster - instance - table - app-profile - backup - column-family - encryption-info - row - row-data - row-filters - row-set - batcher - In the hierarchy of API concepts