From 8ddb859c8178043c0dcd09c85d68ba5d311563bf Mon Sep 17 00:00:00 2001 From: Dan Lee <71398022+dandhlee@users.noreply.github.com> Date: Thu, 7 Mar 2024 11:37:22 -0500 Subject: [PATCH] docs: fix docs structure for Firestore (#868) * docs: fix docs structure for Firestore * docs: update index page to reflect new structure * docs: fix typo for bundles directory * fix: add google-auth as a direct dependency * update warning filter for grpc --------- Co-authored-by: Anthonios Partheniou --- .../{ => firestore_admin_v1}/admin_client.rst | 0 docs/{ => firestore_bundle}/bundles.rst | 0 docs/{ => firestore_v1}/aggregation.rst | 0 docs/{ => firestore_v1}/batch.rst | 0 docs/{ => firestore_v1}/client.rst | 0 docs/{ => firestore_v1}/collection.rst | 0 docs/{ => firestore_v1}/document.rst | 0 docs/{ => firestore_v1}/field_path.rst | 0 docs/{ => firestore_v1}/query.rst | 0 docs/{ => firestore_v1}/transaction.rst | 0 docs/{ => firestore_v1}/transforms.rst | 0 docs/{ => firestore_v1}/types.rst | 0 docs/index.rst | 26 ++++++++++--------- 13 files changed, 14 insertions(+), 12 deletions(-) rename docs/{ => firestore_admin_v1}/admin_client.rst (100%) rename docs/{ => firestore_bundle}/bundles.rst (100%) rename docs/{ => firestore_v1}/aggregation.rst (100%) rename docs/{ => firestore_v1}/batch.rst (100%) rename docs/{ => firestore_v1}/client.rst (100%) rename docs/{ => firestore_v1}/collection.rst (100%) rename docs/{ => firestore_v1}/document.rst (100%) rename docs/{ => firestore_v1}/field_path.rst (100%) rename docs/{ => firestore_v1}/query.rst (100%) rename docs/{ => firestore_v1}/transaction.rst (100%) rename docs/{ => firestore_v1}/transforms.rst (100%) rename docs/{ => firestore_v1}/types.rst (100%) diff --git a/docs/admin_client.rst b/docs/firestore_admin_v1/admin_client.rst similarity index 100% rename from docs/admin_client.rst rename to docs/firestore_admin_v1/admin_client.rst diff --git a/docs/bundles.rst b/docs/firestore_bundle/bundles.rst similarity index 100% rename from docs/bundles.rst rename to docs/firestore_bundle/bundles.rst diff --git a/docs/aggregation.rst b/docs/firestore_v1/aggregation.rst similarity index 100% rename from docs/aggregation.rst rename to docs/firestore_v1/aggregation.rst diff --git a/docs/batch.rst b/docs/firestore_v1/batch.rst similarity index 100% rename from docs/batch.rst rename to docs/firestore_v1/batch.rst diff --git a/docs/client.rst b/docs/firestore_v1/client.rst similarity index 100% rename from docs/client.rst rename to docs/firestore_v1/client.rst diff --git a/docs/collection.rst b/docs/firestore_v1/collection.rst similarity index 100% rename from docs/collection.rst rename to docs/firestore_v1/collection.rst diff --git a/docs/document.rst b/docs/firestore_v1/document.rst similarity index 100% rename from docs/document.rst rename to docs/firestore_v1/document.rst diff --git a/docs/field_path.rst b/docs/firestore_v1/field_path.rst similarity index 100% rename from docs/field_path.rst rename to docs/firestore_v1/field_path.rst diff --git a/docs/query.rst b/docs/firestore_v1/query.rst similarity index 100% rename from docs/query.rst rename to docs/firestore_v1/query.rst diff --git a/docs/transaction.rst b/docs/firestore_v1/transaction.rst similarity index 100% rename from docs/transaction.rst rename to docs/firestore_v1/transaction.rst diff --git a/docs/transforms.rst b/docs/firestore_v1/transforms.rst similarity index 100% rename from docs/transforms.rst rename to docs/firestore_v1/transforms.rst diff --git a/docs/types.rst b/docs/firestore_v1/types.rst similarity index 100% rename from docs/types.rst rename to docs/firestore_v1/types.rst diff --git a/docs/index.rst b/docs/index.rst index 8cf2a17e8..f08250c12 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,18 +8,20 @@ API Reference .. toctree:: :maxdepth: 2 - client - collection - aggregation - document - field_path - query - batch - bundles - transaction - transforms - types - admin_client + firestore_admin_v1/admin_client + + firestore_bundle/bundles + + firestore_v1/aggregation + firestore_v1/batch + firestore_v1/client + firestore_v1/collection + firestore_v1/document + firestore_v1/field_path + firestore_v1/query + firestore_v1/transaction + firestore_v1/transforms + firestore_v1/types Migration Guide ---------------