Use sphinx-apidoc to to generate API docs

sontek · sontek · commit e7f52f2aba6f · 2015-02-10T08:59:28.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -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
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,6 +30,7 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
     'sphinx.ext.viewcode',
     'sphinxcontrib.napoleon',
 ]
@@ -57,7 +58,7 @@
 # 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
@@ -48,7 +48,7 @@ Contents
    install
    tests
    usage
-   api_reference
+   API reference </apidoc/modules>
 
 Indices and tables
 ==================
diff --git a/tox.ini b/tox.ini
@@ -46,4 +46,5 @@ deps =
     sphinx
 
 commands =
+    sphinx-apidoc -o docs/apidoc/ kafka/
     sphinx-build -b html docs/ docs/_build
