diff options
author | Dana Powers <dana.powers@rd.io> | 2016-01-07 18:51:14 -0800 |
---|---|---|
committer | Dana Powers <dana.powers@rd.io> | 2016-01-07 18:51:14 -0800 |
commit | 828377377da43749af0d27ee256ef31bf714cf17 (patch) | |
tree | fbad4d4381fc4d1ea2be7ce2009214d18fbeb674 /docs/apidoc | |
parent | 71e7568fcb8132899f366b37c32645fd5a40dc4b (diff) | |
parent | 9a8af1499ca425366d934487469d9977fae7fe5f (diff) | |
download | kafka-python-828377377da43749af0d27ee256ef31bf714cf17.tar.gz |
Merge branch '0.9'
Conflicts:
kafka/codec.py
kafka/version.py
test/test_producer.py
test/test_producer_integration.py
Diffstat (limited to 'docs/apidoc')
-rw-r--r-- | docs/apidoc/BrokerConnection.rst | 5 | ||||
-rw-r--r-- | docs/apidoc/KafkaClient.rst | 5 | ||||
-rw-r--r-- | docs/apidoc/KafkaConsumer.rst | 5 | ||||
-rw-r--r-- | docs/apidoc/KafkaProducer.rst | 4 | ||||
-rw-r--r-- | docs/apidoc/SimpleProducer.rst | 14 | ||||
-rw-r--r-- | docs/apidoc/kafka.coordinator.assignors.rst | 30 | ||||
-rw-r--r-- | docs/apidoc/kafka.coordinator.rst | 45 | ||||
-rw-r--r-- | docs/apidoc/kafka.protocol.rst | 126 | ||||
-rw-r--r-- | docs/apidoc/modules.rst | 11 |
9 files changed, 241 insertions, 4 deletions
diff --git a/docs/apidoc/BrokerConnection.rst b/docs/apidoc/BrokerConnection.rst new file mode 100644 index 0000000..c56cf42 --- /dev/null +++ b/docs/apidoc/BrokerConnection.rst @@ -0,0 +1,5 @@ +BrokerConnection +================ + +.. autoclass:: kafka.BrokerConnection + :members: diff --git a/docs/apidoc/KafkaClient.rst b/docs/apidoc/KafkaClient.rst new file mode 100644 index 0000000..5c9d736 --- /dev/null +++ b/docs/apidoc/KafkaClient.rst @@ -0,0 +1,5 @@ +KafkaClient +=========== + +.. autoclass:: kafka.KafkaClient + :members: diff --git a/docs/apidoc/KafkaConsumer.rst b/docs/apidoc/KafkaConsumer.rst new file mode 100644 index 0000000..39062c6 --- /dev/null +++ b/docs/apidoc/KafkaConsumer.rst @@ -0,0 +1,5 @@ +KafkaConsumer +============= + +.. autoclass:: kafka.KafkaConsumer + :members: diff --git a/docs/apidoc/KafkaProducer.rst b/docs/apidoc/KafkaProducer.rst new file mode 100644 index 0000000..c33b2f9 --- /dev/null +++ b/docs/apidoc/KafkaProducer.rst @@ -0,0 +1,4 @@ +KafkaProducer +============= + +<unreleased> See :class:`kafka.producer.SimpleProducer` diff --git a/docs/apidoc/SimpleProducer.rst b/docs/apidoc/SimpleProducer.rst new file mode 100644 index 0000000..a509858 --- /dev/null +++ b/docs/apidoc/SimpleProducer.rst @@ -0,0 +1,14 @@ +SimpleProducer +============== + +.. autoclass:: kafka.producer.SimpleProducer + :members: + :show-inheritance: + +.. autoclass:: kafka.producer.KeyedProducer + :members: + :show-inheritance: + +.. automodule:: kafka.producer.base + :members: + :show-inheritance: diff --git a/docs/apidoc/kafka.coordinator.assignors.rst b/docs/apidoc/kafka.coordinator.assignors.rst new file mode 100644 index 0000000..87b9f84 --- /dev/null +++ b/docs/apidoc/kafka.coordinator.assignors.rst @@ -0,0 +1,30 @@ +kafka.coordinator.assignors package +=================================== + +Submodules +---------- + +kafka.coordinator.assignors.abstract module +------------------------------------------- + +.. automodule:: kafka.coordinator.assignors.abstract + :members: + :undoc-members: + :show-inheritance: + +kafka.coordinator.assignors.roundrobin module +--------------------------------------------- + +.. automodule:: kafka.coordinator.assignors.roundrobin + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: kafka.coordinator.assignors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidoc/kafka.coordinator.rst b/docs/apidoc/kafka.coordinator.rst new file mode 100644 index 0000000..e15f638 --- /dev/null +++ b/docs/apidoc/kafka.coordinator.rst @@ -0,0 +1,45 @@ +kafka.coordinator package +========================= + +Subpackages +----------- + +.. toctree:: + + kafka.coordinator.assignors + +Submodules +---------- + +kafka.coordinator.base module +----------------------------- + +.. automodule:: kafka.coordinator.base + :members: + :undoc-members: + :show-inheritance: + +kafka.coordinator.consumer module +--------------------------------- + +.. automodule:: kafka.coordinator.consumer + :members: + :undoc-members: + :show-inheritance: + +kafka.coordinator.heartbeat module +---------------------------------- + +.. automodule:: kafka.coordinator.heartbeat + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: kafka.coordinator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidoc/kafka.protocol.rst b/docs/apidoc/kafka.protocol.rst new file mode 100644 index 0000000..4e69aaf --- /dev/null +++ b/docs/apidoc/kafka.protocol.rst @@ -0,0 +1,126 @@ +kafka.protocol package +====================== + +Submodules +---------- + +kafka.protocol.abstract module +------------------------------ + +.. automodule:: kafka.protocol.abstract + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.admin module +--------------------------- + +.. automodule:: kafka.protocol.admin + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.api module +------------------------- + +.. automodule:: kafka.protocol.api + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.commit module +---------------------------- + +.. automodule:: kafka.protocol.commit + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.fetch module +--------------------------- + +.. automodule:: kafka.protocol.fetch + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.group module +--------------------------- + +.. automodule:: kafka.protocol.group + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.legacy module +---------------------------- + +.. automodule:: kafka.protocol.legacy + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.message module +----------------------------- + +.. automodule:: kafka.protocol.message + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.metadata module +------------------------------ + +.. automodule:: kafka.protocol.metadata + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.offset module +---------------------------- + +.. automodule:: kafka.protocol.offset + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.pickle module +---------------------------- + +.. automodule:: kafka.protocol.pickle + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.produce module +----------------------------- + +.. automodule:: kafka.protocol.produce + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.struct module +---------------------------- + +.. automodule:: kafka.protocol.struct + :members: + :undoc-members: + :show-inheritance: + +kafka.protocol.types module +--------------------------- + +.. automodule:: kafka.protocol.types + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: kafka.protocol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidoc/modules.rst b/docs/apidoc/modules.rst index db3e580..f6eb798 100644 --- a/docs/apidoc/modules.rst +++ b/docs/apidoc/modules.rst @@ -1,7 +1,10 @@ -kafka -===== +kafka-python API +**************** .. toctree:: - :maxdepth: 4 - kafka + KafkaConsumer + KafkaProducer + KafkaClient + BrokerConnection + SimpleProducer |