summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDana Powers <dana.powers@rd.io>2015-12-06 17:55:20 -0800
committerDana Powers <dana.powers@rd.io>2015-12-06 17:55:50 -0800
commit205c9506c6795bfb7f3bb38ad585f9fa29a94f88 (patch)
tree761e1a1e75d1debe889faba7c99948903eea12f0 /docs
parent0f07871951c374d6371b53e942c62e0f708718ed (diff)
downloadkafka-python-205c9506c6795bfb7f3bb38ad585f9fa29a94f88.tar.gz
Update docs for new release
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py8
-rw-r--r--docs/index.rst24
2 files changed, 20 insertions, 12 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 2979560..dc68fd4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -49,7 +49,7 @@ master_doc = 'index'
# General information about the project.
project = u'kafka-python'
-copyright = u'2015, David Arthur'
+copyright = u'2015 - David Arthur, Dana Powers, and Contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -203,7 +203,7 @@ latex_elements = {
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'kafka-python.tex', u'kafka-python Documentation',
- u'David Arthur', 'manual'),
+ u'Dana Powers', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -233,7 +233,7 @@ latex_documents = [
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'kafka-python', u'kafka-python Documentation',
- [u'David Arthur'], 1)
+ [u'Dana Powers'], 1)
]
# If true, show URL addresses after external links.
@@ -247,7 +247,7 @@ man_pages = [
# dir menu entry, description, category)
texinfo_documents = [
('index', 'kafka-python', u'kafka-python Documentation',
- u'David Arthur', 'kafka-python', 'One line description of project.',
+ u'Dana Powers', 'kafka-python', 'One line description of project.',
'Miscellaneous'),
]
diff --git a/docs/index.rst b/docs/index.rst
index b7e7ccd..fa77a8e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,37 +6,45 @@ high-level consumer and producer classes. Request batching is supported by the
protocol as well as broker-aware request routing. Gzip and Snappy compression
is also supported for message sets.
-http://kafka.apache.org/
+Coordinated Consumer Group support is under development - see Issue #38.
On Freenode IRC at #kafka-python, as well as #apache-kafka
For general discussion of kafka-client design and implementation (not python specific),
see https://groups.google.com/forum/m/#!forum/kafka-clients
+For information about Apache Kafka generally, see https://kafka.apache.org/
+
Status
------
-The current stable version of this package is `0.9.4 <https://github.com/dpkp/kafka-python/releases/tag/v0.9.4>`_ and is compatible with:
+The current stable version of this package is `0.9.5 <https://github.com/dpkp/kafka-python/releases/tag/v0.9.5>`_ and is compatible with:
Kafka broker versions
-* 0.8.2.1 [offset management currently ZK only -- does not support ConsumerCoordinator offset management APIs]
+* 0.9.0.0
+* 0.8.2.2
+* 0.8.2.1
* 0.8.1.1
* 0.8.1
* 0.8.0
Python versions
-* 2.6 (tested on 2.6.9)
-* 2.7 (tested on 2.7.9)
-* 3.3 (tested on 3.3.5)
+* 3.5 (tested on 3.5.0)
* 3.4 (tested on 3.4.2)
+* 3.3 (tested on 3.3.5)
+* 2.7 (tested on 2.7.9)
+* 2.6 (tested on 2.6.9)
* pypy (tested on pypy 2.5.0 / python 2.7.8)
License
-------
-Copyright 2015, David Arthur under Apache License, v2.0. See `LICENSE <https://github.com/dpkp/kafka-python/blob/master/LICENSE>`_.
+Apache License, v2.0. See `LICENSE <https://github.com/dpkp/kafka-python/blob/master/LICENSE>`_.
+
+Copyright 2015, David Arthur, Dana Powers, and Contributors
+(See `AUTHORS <https://github.com/dpkp/kafka-python/blob/master/AUTHORS.md>`_).
Contents
@@ -45,9 +53,9 @@ Contents
.. toctree::
:maxdepth: 2
+ usage
install
tests
- usage
API reference </apidoc/modules>
Indices and tables