summaryrefslogtreecommitdiff
path: root/docs/api.rst
diff options
context:
space:
mode:
authorKenneth Reitz <me@kennethreitz.com>2010-10-07 16:01:09 -0400
committerKenneth Reitz <me@kennethreitz.com>2010-10-07 16:01:09 -0400
commit9efd982bfac2bc00877b0cf09cd8b28e1ddc07d5 (patch)
treea0482ce84056112b6f0919d90213bb51836a6472 /docs/api.rst
parenta3c82804cdd7c9f2215b5abd074ca2d166aa1f7c (diff)
downloadtablib-9efd982bfac2bc00877b0cf09cd8b28e1ddc07d5.tar.gz
Documentation update.
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 0000000..28f3f70
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,26 @@
+.. _api:
+
+API
+===
+
+.. module:: flask
+
+This part of the documentation covers all the interfaces of Tablib. For
+parts where Tablib depends on external libraries, we document the most
+important right here and provide links to the canonical documentation.
+
+
+Dataset Object
+--------------
+.. module:: tablib
+
+.. autoclass:: Dataset
+ :members:
+ :inherited-members:
+
+Databook Object
+---------------
+
+.. autoclass:: Databook
+ :members:
+ :inherited-members: