summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKevin Horn <kevin.horn@gmail.com>2013-02-19 21:20:32 -0600
committerKevin Horn <kevin.horn@gmail.com>2013-02-19 21:20:32 -0600
commit421d591fabfcdd3e6ae02e82e81dec481898c261 (patch)
tree1cd9f83edabbcdd3f012f0e5fc7469c72d1e3da3 /docs
parenta507337e387ca6ddc0b8e6dfe36a2a6e6d8e9962 (diff)
downloadwheel-git-421d591fabfcdd3e6ae02e82e81dec481898c261.tar.gz
Add automatic API file, and update conf.py and index.rst to account for it.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst72
-rw-r--r--docs/conf.py2
-rw-r--r--docs/index.rst1
3 files changed, 74 insertions, 1 deletions
diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 0000000..22cf11a
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,72 @@
+API Documentation
+=================
+
+wheel.archive
+-------------
+
+.. automodule:: wheel.archive
+ :members:
+
+
+wheel.bdist_wheel
+-----------------
+
+.. automodule:: wheel.bdist_wheel
+ :members:
+
+
+wheel.decorator
+---------------
+
+.. automodule:: wheel.decorator
+ :members:
+
+
+wheel.egg2wheel
+---------------
+
+.. automodule:: wheel.egg2wheel
+ :members:
+
+
+wheel.install
+-------------
+
+.. automodule:: wheel.install
+ :members:
+
+
+wheel.paths
+-----------
+
+.. automodule:: wheel.paths
+ :members:
+
+
+wheel.pep425tags
+----------------
+
+.. automodule:: wheel.pep425tags
+ :members:
+
+
+wheel.pkginfo
+-------------
+
+.. automodule:: wheel.pkginfo
+ :members:
+
+
+wheel.util
+----------
+
+.. automodule:: wheel.util
+ :members:
+
+
+wheel.wininst2wheel
+-------------------
+
+.. automodule:: wheel.wininst2wheel
+ :members:
+
diff --git a/docs/conf.py b/docs/conf.py
index 982a6a1..62b1001 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -25,7 +25,7 @@ import sys, os, pkg_resources
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
+extensions = ['sphinx.ext.autodoc']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
diff --git a/docs/index.rst b/docs/index.rst
index 57f5c95..9c5bb42 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -103,4 +103,5 @@ Wheel
:maxdepth: 2
story
+ api