diff options
| author | Kenneth Reitz <me@kennethreitz.com> | 2010-10-10 04:37:09 -0400 |
|---|---|---|
| committer | Kenneth Reitz <me@kennethreitz.com> | 2010-10-10 04:37:09 -0400 |
| commit | 7fda829d275c1375d7399f2c9234e0bf0093dbc3 (patch) | |
| tree | c14a566da2ab6ecdc5fc183066177cc9b622e5d7 /docs/api.rst | |
| parent | ca08ac8a7bd8eed94e1aa186a9530be728c1dca7 (diff) | |
| download | tablib-7fda829d275c1375d7399f2c9234e0bf0093dbc3.tar.gz | |
Documentation update.
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst index ce169b7..4a0ff52 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,8 +1,10 @@ .. _api: +=== API === + .. module:: tablib This part of the documentation covers all the interfaces of Tablib. For @@ -10,18 +12,53 @@ parts where Tablib depends on external libraries, we document the most important right here and provide links to the canonical documentation. +-------------- Dataset Object -------------- + + .. autoclass:: Dataset :inherited-members: +--------------- Databook Object --------------- + .. autoclass:: Databook :inherited-members: +--------- +Functions +--------- + + +.. autofunction:: detect + +.. autofunction:: import_set + + +---------- +Exceptions +---------- + + +.. class:: InvalidDatasetType + + Raised when shit goes down. + + +.. class:: InvalidDimensions + + Raised when shit goes down. + + +.. class:: UnsupportedFormat + + Raised when shit goes down. + + Now, go start some :ref:`Tablib Development <development>`.
\ No newline at end of file |