Documentation update.

This commit is contained in:
Kenneth Reitz
2010-10-07 16:01:09 -04:00
parent a3c82804cd
commit 9efd982bfa
3 changed files with 51 additions and 13 deletions
+26
View File
@@ -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:
+25 -13
View File
@@ -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
------------
Databook Object
---------------
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.
.. autoclass:: Dataset
:members:
:inherited-members:
.. toctree::
:maxdepth: 2
installation
API Reference
-------------
If you are looking for information on a specific function, class or
method, this part of the documentation is for you.
.. toctree::
:maxdepth: 2
api
View File