summaryrefslogtreecommitdiff
path: root/docs/apidoc/kafka.rst
diff options
context:
space:
mode:
authorDana Powers <dana.powers@gmail.com>2015-02-10 16:24:42 -0800
committerDana Powers <dana.powers@gmail.com>2015-02-10 16:24:42 -0800
commite94fd220923e3b24f27636cc8bb4f39ab89dcb73 (patch)
tree798067f941495afce28e350651fa8b91cb560682 /docs/apidoc/kafka.rst
parent2a12fed46fa91f3a7f671cf35a9a4660366e5289 (diff)
parent70b3af1b3c742973609151f408b60ebb8aff5701 (diff)
downloadkafka-python-e94fd220923e3b24f27636cc8bb4f39ab89dcb73.tar.gz
Merge pull request #316 from sontek/add_docs_to_tox
Allow better usage of docs locally.
Diffstat (limited to 'docs/apidoc/kafka.rst')
-rw-r--r--docs/apidoc/kafka.rst79
1 files changed, 79 insertions, 0 deletions
diff --git a/docs/apidoc/kafka.rst b/docs/apidoc/kafka.rst
new file mode 100644
index 0000000..eb04c35
--- /dev/null
+++ b/docs/apidoc/kafka.rst
@@ -0,0 +1,79 @@
+kafka package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+
+ kafka.consumer
+ kafka.partitioner
+ kafka.producer
+
+Submodules
+----------
+
+kafka.client module
+-------------------
+
+.. automodule:: kafka.client
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+kafka.codec module
+------------------
+
+.. automodule:: kafka.codec
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+kafka.common module
+-------------------
+
+.. automodule:: kafka.common
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+kafka.conn module
+-----------------
+
+.. automodule:: kafka.conn
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+kafka.context module
+--------------------
+
+.. automodule:: kafka.context
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+kafka.protocol module
+---------------------
+
+.. automodule:: kafka.protocol
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+kafka.util module
+-----------------
+
+.. automodule:: kafka.util
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: kafka
+ :members:
+ :undoc-members:
+ :show-inheritance: