Add improvements to documentation (#351)

* cleanup docs build process and add various improvements

* fix formatting issue with aerospike on index.rst

* add warning to globaltable.py docs

* update rocksdb docs

* fix linting

Author: wbarnha

docs/reference/index.rst

@@ -128,7 +128,7 @@ Stores
     faust.stores.base
     faust.stores.memory
     faust.stores.rocksdb
-	faust.stores.aerospike
+    faust.stores.aerospike
 
 Tables
 ======

faust/stores/rocksdb.py

@@ -232,6 +232,12 @@ async def backup_partition(
         This is only supported in newer versions of python-rocksdb which can read
         the RocksDB database using multi-process read access.
         See https://github.com/facebook/rocksdb/wiki/How-to-backup-RocksDB to know more.
+
+        Example usage::
+
+            table = app.GlobalTable(..., partitions=1)
+            table.data.backup_partition(0, flush=True, purge=True, keep=1)
+
         """
         if self._backup_engine:
             partition = tp
@@ -260,6 +266,11 @@ def restore_backup(
             latest: Restore the latest backup, set as False to restore a specific ID
             backup_id: Backup to restore
 
+        An example of how the method can be accessed::
+
+            table = app.GlobalTable(..., partitions=1)
+            table.data.restore_backup(0)
+
         """
         if self._backup_engine:
             partition = tp

faust/tables/globaltable.py

@@ -3,4 +3,13 @@
 
 
 class GlobalTable(Table, GlobalTableT):
+    """
+    .. warning::
+        Using a GlobalTable with multiple app instances may cause an
+        app to be stuck in an infinite recovery loop. The current fix
+        for this is to run the table with the following options::
+
+            app.GlobalTable(..., partitions=1, recovery_buffer_size=1)
+    """
+
     pass