diff options
| author | John Anderson <sontek@gmail.com> | 2015-02-10 08:59:28 -0800 |
|---|---|---|
| committer | John Anderson <sontek@gmail.com> | 2015-02-10 08:59:28 -0800 |
| commit | e7f52f2aba6fc59c0221ae08fd931fc5276d7eef (patch) | |
| tree | cd9c2cfe24da9bf78224b6729bc3cd8e12a8336c | |
| parent | c88e3cedf44c257a9dc4c00017114fca3f4e58c0 (diff) | |
| download | kafka-python-e7f52f2aba6fc59c0221ae08fd931fc5276d7eef.tar.gz | |
Use sphinx-apidoc to to generate API docs
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | docs/api_reference.rst | 64 | ||||
| -rw-r--r-- | docs/conf.py | 3 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | tox.ini | 1 |
5 files changed, 5 insertions, 66 deletions
@@ -9,3 +9,4 @@ servers/*/kafka-bin .coverage .noseids docs/_build +docs/apidoc diff --git a/docs/api_reference.rst b/docs/api_reference.rst deleted file mode 100644 index 8804664..0000000 --- a/docs/api_reference.rst +++ /dev/null @@ -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: diff --git a/docs/conf.py b/docs/conf.py index 25b3d4d..ea223c2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 diff --git a/docs/index.rst b/docs/index.rst index cdcddbc..e4a9ac7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -48,7 +48,7 @@ Contents install tests usage - api_reference + API reference </apidoc/modules> Indices and tables ================== @@ -46,4 +46,5 @@ deps = sphinx commands = + sphinx-apidoc -o docs/apidoc/ kafka/ sphinx-build -b html docs/ docs/_build |