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
|
.coverage
|
||||||
.noseids
|
.noseids
|
||||||
docs/_build
|
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.
|
# ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
|
'sphinx.ext.intersphinx',
|
||||||
'sphinx.ext.viewcode',
|
'sphinx.ext.viewcode',
|
||||||
'sphinxcontrib.napoleon',
|
'sphinxcontrib.napoleon',
|
||||||
]
|
]
|
||||||
|
@@ -48,7 +48,7 @@ Contents
|
|||||||
install
|
install
|
||||||
tests
|
tests
|
||||||
usage
|
usage
|
||||||
api_reference
|
API reference </apidoc/modules>
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
Reference in New Issue
Block a user