summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorKenneth Reitz <me@kennethreitz.com>2010-10-05 17:29:43 -0400
committerKenneth Reitz <me@kennethreitz.com>2010-10-05 17:29:43 -0400
commit9c7707be60791f6e17eb583a833dc29856511208 (patch)
treeb6bd68a1ae668aa6c0c1d5eec14c7311fb1063ff /docs/index.rst
parent14bee652084b47852b1c266fc18d298299e49c26 (diff)
downloadtablib-9c7707be60791f6e17eb583a833dc29856511208.tar.gz
Added generic doctesting.
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..bb0589c
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,34 @@
+.. Tablib documentation master file, created by
+ sphinx-quickstart on Tue Oct 5 15:25:21 2010.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Tablib's documentation!
+==================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+Dataset Object
+--------------
+.. module:: tablib
+
+.. autoclass:: Databook
+ :members:
+ :inherited-members:
+
+Databook Object
+---------------
+
+.. autoclass:: Dataset
+ :members:
+ :inherited-members: