From 48def2cba6a9125b32b4455374297b7160507f37 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Thu, 7 Oct 2010 17:52:21 -0400 Subject: [PATCH] Documentation Update. Site should be up soon. --- docs/development.rst | 18 +++++++++++++++ docs/index.rst | 52 +++++++++++++++++++++++++++++--------------- docs/install.rst | 41 ++++++++++++++++++++++++++++++++++ docs/intro.rst | 19 ++++++++++++++++ docs/quickstart.rst | 20 +++++++++++++++++ 5 files changed, 133 insertions(+), 17 deletions(-) create mode 100644 docs/development.rst create mode 100644 docs/intro.rst create mode 100644 docs/quickstart.rst diff --git a/docs/development.rst b/docs/development.rst new file mode 100644 index 0000000..7a574c6 --- /dev/null +++ b/docs/development.rst @@ -0,0 +1,18 @@ +.. _development: + +Development +=========== + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + +Future of Tablib +---------------- + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + +Design Considerations +--------------------- + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 97e520b..058335e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,27 +3,29 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Tablib -================= +Tablib: Pythonic Tabular Data +============================= Welcome to Tablib's docuemtation. +.. Contents: +.. +.. .. toctree:: +.. :maxdepth: 2 +.. + +.. Indices and tables +.. ================== +.. +.. * :ref:`genindex` +.. * :ref:`modindex` +.. * :ref:`search` + + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + I recommend you start off with `Installation`. -Contents: - -.. toctree:: - :maxdepth: 2 - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - - User's Guide ------------ @@ -32,7 +34,23 @@ This part of the documentation, which is mostly prose, begins with some backgrou .. toctree:: :maxdepth: 2 - installation + intro + +.. toctree:: + :maxdepth: 2 + + install + +.. toctree:: + :maxdepth: 2 + + quickstart + +.. toctree:: + :maxdepth: 2 + + development + API Reference ------------- diff --git a/docs/install.rst b/docs/install.rst index e69de29..4801eee 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -0,0 +1,41 @@ +.. _install: + +Installation +============ + +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. + + +Installing Tablib +----------------- + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + +Pythons Supported +----------------- + +At this time, only the following Python platforms are officially supported: + +* Python 2.6 +* Python 2.7 + +Other Pythons will be supported soon. + + +C Extentions +------------ + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + +Virtualenv +---------- + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + +Staying Updated +--------------- + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. \ No newline at end of file diff --git a/docs/intro.rst b/docs/intro.rst new file mode 100644 index 0000000..bfa8a3e --- /dev/null +++ b/docs/intro.rst @@ -0,0 +1,19 @@ +.. _intro: + +Introduction +============ + +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. + +Why Tablib? +----------- + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + +Boiler Plate is Bad +------------------- + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. diff --git a/docs/quickstart.rst b/docs/quickstart.rst new file mode 100644 index 0000000..419ac82 --- /dev/null +++ b/docs/quickstart.rst @@ -0,0 +1,20 @@ +.. _quickstart: + +Quickstart +========== + +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. + + +Basic Usage +----------- + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + +Advanced Usage +-------------- + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. \ No newline at end of file