Use sphinx-apidoc to to generate API docs
This commit is contained in:
1
.gitignore
vendored
1
.gitignore
vendored
@@ -9,3 +9,4 @@ servers/*/kafka-bin
|
||||
.coverage
|
||||
.noseids
|
||||
docs/_build
|
||||
docs/apidoc
|
||||
|
@@ -1,64 +0,0 @@
|
||||
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.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:
|
@@ -30,6 +30,7 @@ import os
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinxcontrib.napoleon',
|
||||
]
|
||||
@@ -57,7 +58,7 @@ copyright = u'2015, David Arthur'
|
||||
# The short X.Y version.
|
||||
with open('../VERSION') as version_file:
|
||||
version = version_file.read()
|
||||
|
||||
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = version
|
||||
|
||||
|
@@ -48,7 +48,7 @@ Contents
|
||||
install
|
||||
tests
|
||||
usage
|
||||
api_reference
|
||||
API reference </apidoc/modules>
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
Reference in New Issue
Block a user