Merge pull request #38 from bringhurst/api_docs

Fill out api automodule docs.
linkedin · Jul 6, 2016 · f513a94 · f513a94
2 parents 6f40fe8 + 8eafd47
commit f513a94
Show file tree

Hide file tree

Showing 26 changed files with 139 additions and 4 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -20,6 +20,8 @@ install:
   - pip install sphinx
 script:
   - tox
+  - pip install kazoo # Only for building docs
+  - '[ "${TRAVIS_PYTHON_VERSION}" = "2.6" ] && pip install importlib || true' # Only for building docs
   - sphinx-build -nW -b html -d ./docs/_build/doctrees ./docs ./docs/_build/html
 after_success:
   - codeclimate-test-reporter

diff --git a/docs/index.rst b/docs/index.rst
@@ -17,6 +17,28 @@ API Documentation
 .. toctree::
    :maxdepth: 2
 
+   tools/assigner/actions/balance
+   tools/assigner/actions/balancemodules/count
+   tools/assigner/actions/balancemodules/even
+   tools/assigner/actions/balancemodules/leader
+   tools/assigner/actions/balancemodules/size
+   tools/assigner/actions/clone
+   tools/assigner/actions/elect
+   tools/assigner/actions/remove
+   tools/assigner/actions/reorder
+   tools/assigner/actions/setrf
+   tools/assigner/actions/trim
+   tools/assigner/arguments
+   tools/assigner/batcher
+   tools/assigner/exceptions
+   tools/assigner/models/broker
+   tools/assigner/models/cluster
+   tools/assigner/models/partition
+   tools/assigner/models/reassignment
+   tools/assigner/models/replica_election
+   tools/assigner/models/topic
+   tools/assigner/modules
+   tools/assigner/sizers/ssh
    tools/assigner/tools
 
 Indices and tables

diff --git a/docs/tools/assigner/actions/balance.rst b/docs/tools/assigner/actions/balance.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.balance
+====================================
+
+.. automodule:: kafka.tools.assigner.actions.balance
+   :members:
diff --git a/docs/tools/assigner/actions/balancemodules/count.rst b/docs/tools/assigner/actions/balancemodules/count.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.balancemodules.count
+=================================================
+
+.. automodule:: kafka.tools.assigner.actions.balancemodules.count
+   :members:
diff --git a/docs/tools/assigner/actions/balancemodules/even.rst b/docs/tools/assigner/actions/balancemodules/even.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.balancemodules.even
+================================================
+
+.. automodule:: kafka.tools.assigner.actions.balancemodules.even
+   :members:
diff --git a/docs/tools/assigner/actions/balancemodules/leader.rst b/docs/tools/assigner/actions/balancemodules/leader.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.balancemodules.leader
+==================================================
+
+.. automodule:: kafka.tools.assigner.actions.balancemodules.leader
+   :members:
diff --git a/docs/tools/assigner/actions/balancemodules/size.rst b/docs/tools/assigner/actions/balancemodules/size.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.balancemodules.size
+================================================
+
+.. automodule:: kafka.tools.assigner.actions.balancemodules.size
+   :members:
diff --git a/docs/tools/assigner/actions/clone.rst b/docs/tools/assigner/actions/clone.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.clone
+==================================
+
+.. automodule:: kafka.tools.assigner.actions.clone
+   :members:
diff --git a/docs/tools/assigner/actions/elect.rst b/docs/tools/assigner/actions/elect.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.elect
+==================================
+
+.. automodule:: kafka.tools.assigner.actions.elect
+   :members:
diff --git a/docs/tools/assigner/actions/remove.rst b/docs/tools/assigner/actions/remove.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.remove
+===================================
+
+.. automodule:: kafka.tools.assigner.actions.remove
+   :members:
diff --git a/docs/tools/assigner/actions/reorder.rst b/docs/tools/assigner/actions/reorder.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.reorder
+====================================
+
+.. automodule:: kafka.tools.assigner.actions.reorder
+   :members:
diff --git a/docs/tools/assigner/actions/setrf.rst b/docs/tools/assigner/actions/setrf.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.setrf
+==================================
+
+.. automodule:: kafka.tools.assigner.actions.setrf
+   :members:
diff --git a/docs/tools/assigner/actions/trim.rst b/docs/tools/assigner/actions/trim.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.actions.trim
+==================================
+
+.. automodule:: kafka.tools.assigner.actions.trim
+   :members:
diff --git a/docs/tools/assigner/arguments.rst b/docs/tools/assigner/arguments.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.arguments
+==============================
+
+.. automodule:: kafka.tools.assigner.arguments
+   :members:
diff --git a/docs/tools/assigner/batcher.rst b/docs/tools/assigner/batcher.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.batcher
+============================
+
+.. automodule:: kafka.tools.assigner.batcher
+   :members:
diff --git a/docs/tools/assigner/exceptions.rst b/docs/tools/assigner/exceptions.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.exceptions
+===============================
+
+.. automodule:: kafka.tools.assigner.exceptions
+   :members:
diff --git a/docs/tools/assigner/models/broker.rst b/docs/tools/assigner/models/broker.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.models.broker
+==================================
+
+.. automodule:: kafka.tools.assigner.models.broker
+   :members:
diff --git a/docs/tools/assigner/models/cluster.rst b/docs/tools/assigner/models/cluster.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.models.cluster
+===================================
+
+.. automodule:: kafka.tools.assigner.models.cluster
+   :members:
diff --git a/docs/tools/assigner/models/partition.rst b/docs/tools/assigner/models/partition.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.models.partition
+=====================================
+
+.. automodule:: kafka.tools.assigner.models.partition
+   :members:
diff --git a/docs/tools/assigner/models/reassignment.rst b/docs/tools/assigner/models/reassignment.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.models.reassignment
+========================================
+
+.. automodule:: kafka.tools.assigner.models.reassignment
+   :members:
diff --git a/docs/tools/assigner/models/replica_election.rst b/docs/tools/assigner/models/replica_election.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.models.replica_election
+============================================
+
+.. automodule:: kafka.tools.assigner.models.replica_election
+   :members:
diff --git a/docs/tools/assigner/models/topic.rst b/docs/tools/assigner/models/topic.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.models.topic
+=================================
+
+.. automodule:: kafka.tools.assigner.models.topic
+   :members:
diff --git a/docs/tools/assigner/modules.rst b/docs/tools/assigner/modules.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.modules
+============================
+
+.. automodule:: kafka.tools.assigner.modules
+   :members:
diff --git a/docs/tools/assigner/sizers/ssh.rst b/docs/tools/assigner/sizers/ssh.rst
@@ -0,0 +1,5 @@
+kafka.tools.assigner.sizers.ssh
+===============================
+
+.. automodule:: kafka.tools.assigner.sizers.ssh
+   :members:
diff --git a/docs/tools/assigner/tools.rst b/docs/tools/assigner/tools.rst
@@ -1,5 +1,5 @@
-Kafka assigner tools
-====================
+kafka.tools.assigner.tools
+==========================
 
 .. automodule:: kafka.tools.assigner.tools
    :members:
diff --git a/setup.py b/setup.py
@@ -17,11 +17,12 @@
 ]
 
 # Python 2.6 doesn't have a native importlib
-if sys.version_info[0] == 2 and sys.version_info[1] == 6:
+try:
+    import importlib
+except ImportError:
     install_requires.append('importlib')
     install_requires.append('argparse')
 
-
 class Pex(Command):
     user_options = []