diff options
| author | Kenneth Reitz <me@kennethreitz.com> | 2010-10-07 16:01:09 -0400 |
|---|---|---|
| committer | Kenneth Reitz <me@kennethreitz.com> | 2010-10-07 16:01:09 -0400 |
| commit | 9efd982bfac2bc00877b0cf09cd8b28e1ddc07d5 (patch) | |
| tree | a0482ce84056112b6f0919d90213bb51836a6472 /docs | |
| parent | a3c82804cdd7c9f2215b5abd074ca2d166aa1f7c (diff) | |
| download | tablib-9efd982bfac2bc00877b0cf09cd8b28e1ddc07d5.tar.gz | |
Documentation update.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 26 | ||||
| -rw-r--r-- | docs/index.rst | 38 | ||||
| -rw-r--r-- | docs/install.rst | 0 |
3 files changed, 51 insertions, 13 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: diff --git a/docs/index.rst b/docs/index.rst index bb0589c..97e520b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,14 +3,19 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Tablib's documentation! -================================== +Welcome to Tablib +================= + +Welcome to Tablib's docuemtation. + +I recommend you start off with `Installation`. Contents: .. toctree:: :maxdepth: 2 + Indices and tables ================== @@ -18,17 +23,24 @@ Indices and tables * :ref:`modindex` * :ref:`search` -Dataset Object --------------- -.. module:: tablib -.. autoclass:: Databook - :members: - :inherited-members: +User's Guide +------------ + +This part of the documentation, which is mostly prose, begins with some background information about Tablib, then focuses on step-by-step instructions for web development with Flask. + +.. toctree:: + :maxdepth: 2 + + installation + +API Reference +------------- -Databook Object ---------------- +If you are looking for information on a specific function, class or +method, this part of the documentation is for you. + +.. toctree:: + :maxdepth: 2 -.. autoclass:: Dataset - :members: - :inherited-members: + api
\ No newline at end of file diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/install.rst |