From d4e85ecd1d8acac1a0f74d164b67faefd99987e4 Mon Sep 17 00:00:00 2001 From: Dana Powers Date: Thu, 7 Jan 2016 17:14:49 -0800 Subject: Update docs for release w/ new async classes --- docs/apidoc/BrokerConnection.rst | 5 +++++ docs/apidoc/KafkaClient.rst | 5 +++++ docs/apidoc/KafkaConsumer.rst | 5 +++++ docs/apidoc/KafkaProducer.rst | 4 ++++ docs/apidoc/SimpleProducer.rst | 14 ++++++++++++++ docs/apidoc/modules.rst | 11 +++++++---- 6 files changed, 40 insertions(+), 4 deletions(-) create mode 100644 docs/apidoc/BrokerConnection.rst create mode 100644 docs/apidoc/KafkaClient.rst create mode 100644 docs/apidoc/KafkaConsumer.rst create mode 100644 docs/apidoc/KafkaProducer.rst create mode 100644 docs/apidoc/SimpleProducer.rst (limited to 'docs/apidoc') 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 +============= + + 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/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 -- cgit v1.2.1