diff options
| author | Will Daly <will@edx.org> | 2015-01-04 12:23:10 -0500 |
|---|---|---|
| committer | Will Daly <will.e.daly@gmail.com> | 2015-01-15 18:01:40 -0500 |
| commit | 01f378328e5383d05d52428b815f992eb2c536cb (patch) | |
| tree | 2d3366ed91b9744efd40d935a460040150c6d4d8 /docs/api_reference.rst | |
| parent | 02c2b469003e2ddcb051dbb4d95977137050c19f (diff) | |
| download | kafka-python-01f378328e5383d05d52428b815f992eb2c536cb.tar.gz | |
Add Sphinx API docs
Diffstat (limited to 'docs/api_reference.rst')
| -rw-r--r-- | docs/api_reference.rst | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/docs/api_reference.rst b/docs/api_reference.rst new file mode 100644 index 0000000..5e178f1 --- /dev/null +++ b/docs/api_reference.rst @@ -0,0 +1,67 @@ +API Reference +============= + +kafka +----- +.. automodule:: kafka.client + :members: + +.. automodule:: kafka.codec + :members: + +.. automodule:: kafka.common + :members: + +.. automodule:: kafka.conn + :members: + +.. automodule:: kafka.context + :members: + +.. automodule:: kafka.protocol + :members: + +.. automodule:: kafka.queue + :members: + +.. automodule:: kafka.util + :members: + + +kafka.consumer +-------------- +.. automodule:: kafka.consumer.base + :members: + +.. automodule:: kafka.consumer.kafka + :members: + +.. automodule:: kafka.consumer.multiprocess + :members: + +.. automodule:: kafka.consumer.simple + :members: + + +kafka.partitioner +----------------- +.. automodule:: kafka.partitioner.base + :members: + +.. automodule:: kafka.partitioner.hashed + :members: + +.. automodule:: kafka.partitioner.roundrobin + :members: + + +kafka.producer +-------------- +.. automodule:: kafka.producer.base + :members: + +.. automodule:: kafka.producer.keyed + :members: + +.. automodule:: kafka.producer.simple + :members: |