openstack/deb-python-kafka
Code Issues Proposed changes

Update docs for new release

Browse Source
This commit is contained in:
Dana Powers
2015-12-06 17:55:20 -08:00
parent 0f07871951
commit 205c9506c6
2 changed files with 20 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/conf.py
View File

@@ -49,7 +49,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'kafka-python' 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 # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@@ -203,7 +203,7 @@ latex_elements = {
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
('index', 'kafka-python.tex', u'kafka-python Documentation', ('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 # 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). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'kafka-python', u'kafka-python Documentation', ('index', 'kafka-python', u'kafka-python Documentation',
[u'David Arthur'], 1) [u'Dana Powers'], 1)
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
@@ -247,7 +247,7 @@ man_pages = [
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'kafka-python', u'kafka-python Documentation', ('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'), 'Miscellaneous'),
] ]

24
docs/index.rst
View File

@@ -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 protocol as well as broker-aware request routing. Gzip and Snappy compression
is also supported for message sets. 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 On Freenode IRC at #kafka-python, as well as #apache-kafka
For general discussion of kafka-client design and implementation (not python specific), For general discussion of kafka-client design and implementation (not python specific),
see https://groups.google.com/forum/m/#!forum/kafka-clients see https://groups.google.com/forum/m/#!forum/kafka-clients
For information about Apache Kafka generally, see https://kafka.apache.org/
Status 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 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.1
* 0.8.1 * 0.8.1
* 0.8.0 * 0.8.0
Python versions Python versions
* 2.6 (tested on 2.6.9) * 3.5 (tested on 3.5.0)
* 2.7 (tested on 2.7.9)
* 3.3 (tested on 3.3.5)
* 3.4 (tested on 3.4.2) * 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) * pypy (tested on pypy 2.5.0 / python 2.7.8)
License 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 Contents
@@ -45,9 +53,9 @@ Contents
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
usage
install install
tests tests
usage
API reference </apidoc/modules> API reference </apidoc/modules>
Indices and tables Indices and tables