Use sphinx-apidoc to to generate API docs

This commit is contained in:
John Anderson
2015-02-10 08:59:28 -08:00
parent c88e3cedf4
commit e7f52f2aba
5 changed files with 5 additions and 66 deletions

1
.gitignore vendored
View File

@@ -9,3 +9,4 @@ servers/*/kafka-bin
.coverage
.noseids
docs/_build
docs/apidoc

View File

@@ -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:

View File

@@ -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

View File

@@ -48,7 +48,7 @@ Contents
install
tests
usage
api_reference
API reference </apidoc/modules>
Indices and tables
==================

View File

@@ -46,4 +46,5 @@ deps =
sphinx
commands =
sphinx-apidoc -o docs/apidoc/ kafka/
sphinx-build -b html docs/ docs/_build