Moving table garbage collection autodocs into separate page.

dhermes · Jul 28, 2015 · 21e131f · 21e131f
1 parent f9c8807
commit 21e131f
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/docs/garbage-collection.rst b/docs/garbage-collection.rst
@@ -0,0 +1,17 @@
+Table Garbage Collection
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: gcloud_bigtable.table.GarbageCollectionRule
+  :members:
+  :undoc-members:
+  :show-inheritance:
+
+.. autoclass:: gcloud_bigtable.table.GarbageCollectionRuleUnion
+  :members:
+  :undoc-members:
+  :show-inheritance:
+
+.. autoclass:: gcloud_bigtable.table.GarbageCollectionRuleIntersection
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -158,13 +158,13 @@ Documented Modules
    client
    cluster
    table
+   garbage-collection
 
 Indices and tables
 ~~~~~~~~~~~~~~~~~~
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
 
 .. _Cluster Admin API: https://cloud.google.com/bigtable/docs/creating-cluster
 .. _CreateCluster: https://github.com/GoogleCloudPlatform/cloud-bigtable-client/blob/e6fc386d9adc821e1cf5c175c5bf5830b641eb3f/bigtable-protos/src/main/proto/google/bigtable/admin/cluster/v1/bigtable_cluster_service.proto#L66-L68

diff --git a/docs/table.rst b/docs/table.rst
@@ -5,3 +5,5 @@ Table
   :members:
   :undoc-members:
   :show-inheritance:
+  :exclude-members: GarbageCollectionRule,GarbageCollectionRuleUnion,
+                    GarbageCollectionRuleIntersection