diff options
| author | Dana Powers <dana.powers@gmail.com> | 2015-01-23 09:41:03 -0800 |
|---|---|---|
| committer | Dana Powers <dana.powers@gmail.com> | 2015-01-23 09:41:03 -0800 |
| commit | 587206ff6ad59ae01248d24ff9c9fadbdfc1c1fc (patch) | |
| tree | a2d6f02a0c79ab3774527df39faf21deb4632936 /docs/api_reference.rst | |
| parent | e6b37c00c5b0a52f821b35a4e26c0943f3e05b07 (diff) | |
| parent | 01f378328e5383d05d52428b815f992eb2c536cb (diff) | |
| download | kafka-python-587206ff6ad59ae01248d24ff9c9fadbdfc1c1fc.tar.gz | |
Merge pull request #282 from wedaly/sphinx-api-docs
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: |