create doc skeleton

docs/source/api/core/backendscfg.rst

@@ -0,0 +1,6 @@
+:mod:`weboob.core.backendscfg`
+==============================
+
+.. automodule:: weboob.core.backendscfg
+   :members:
+   :undoc-members:

docs/source/api/core/bcall.rst

@@ -0,0 +1,6 @@
+:mod:`weboob.core.bcall`
+========================
+
+.. automodule:: weboob.core.bcall
+   :members:
+   :undoc-members:

docs/source/api/core/index.rst

@@ -0,0 +1,13 @@
+:mod:`weboob.core`
+==================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   backendscfg
+   bcall
+   modules
+   ouiboube
+   scheduler

docs/source/api/core/modules.rst

@@ -0,0 +1,6 @@
+:mod:`weboob.core.modules`
+==========================
+
+.. automodule:: weboob.core.modules
+   :members:
+   :undoc-members:

docs/source/api/core/ouiboube.rst

@@ -0,0 +1,6 @@
+:mod:`weboob.core.ouiboube`
+===========================
+
+.. automodule:: weboob.core.ouiboube
+   :members:
+   :undoc-members:

docs/source/api/core/scheduler.rst

@@ -0,0 +1,6 @@
+:mod:`weboob.core.scheduler`
+============================
+
+.. automodule:: weboob.core.scheduler
+   :members:
+   :undoc-members:

docs/source/api/index.rst

@@ -0,0 +1,10 @@
+API
+===
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   core/index
+   tools/index

docs/source/api/tools/backend.rst

@@ -0,0 +1,6 @@
+:mod:`weboob.tools.backend`
+===========================
+
+.. automodule:: weboob.tools.backend
+   :members:
+   :undoc-members:

docs/source/api/tools/index.rst

@@ -0,0 +1,9 @@
+:mod:`weboob.tools`
+===================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   backend

docs/source/applications.rst

@@ -0,0 +1,5 @@
+Applications
+============
+
+boobank
+-------

docs/source/backends.rst

@@ -0,0 +1,5 @@
+Backends
+========
+
+cragr
+-----

docs/source/guides/application.rst

@@ -0,0 +1,2 @@
+Application development
+=======================

docs/source/guides/backend.rst

@@ -0,0 +1,2 @@
+Backend development
+===================

docs/source/guides/index.rst

@@ -0,0 +1,10 @@
+Guides
+======
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   application
+   backend

docs/source/index.rst

@@ -1,16 +1,23 @@
-.. Weboob documentation master file, created by
+Weboob
-   sphinx-quickstart on Thu Nov 25 11:56:52 2010.
+======
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
-Welcome to Weboob's documentation!
+This is the developer documentation.
-==================================
+
+.. warning::
+   This documentation is being written.
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   overview
+   install
+   backends
+   applications
+   guides/index
+   api/index
+
 Indices and tables
 ==================
 

docs/source/install.rst

@@ -0,0 +1,30 @@
+Installation
+============
+
+If you install Weboob from sources, you'll want to install the Python egg in development mode.
+You'll be able to update the git repository with remote changes, without re-installing the software.
+And if you plan to hack on Weboob, you'll see your own changes apply the same way.
+
+Install
+-------
+
+As root:
+
+``# ./setup.py develop``
+
+The development mode installation doesn't copies files, but creates an egg-link
+in the Python system packages directory:
+
+* ``/usr/lib/python2.5/site-packages`` for Python 2.5
+* ``/usr/local/lib/python2.6/dist-packages`` for Python 2.6
+
+Scripts are copied to:
+
+* ``/usr/bin`` for Python 2.5
+* ``/usr/local/bin`` for Python 2.6
+
+Uninstall
+---------
+
+* remove the ``/usr/local/lib/python2.6/dist-packages/weboob.egg-link``
+* remove the weboob line from ``/usr/local/lib/python2.6/dist-packages/easy-install.pth``

docs/source/overview.rst

@@ -0,0 +1,44 @@
+Overview
+========
+
+Weboob (Web Out Of Browsers) provides:
+
+* :doc:`applications` to interact with websites
+* :doc:`backends`, each one handles a specific website
+* a :doc:`core library <api/core/index>` providing all the features needed by backends
+* :doc:`tools <api/tools/index>` to help develop backends and applications
+
+Weboob is written in Python and is distributed under the GPLv3 license.
+
+Why using Weboob?
+-----------------
+
+* you get essential information faster
+* you can write scripts using weboob to automate tasks
+* it extends websites features
+* it helps blind people using crappy websites
+
+Capabilities
+------------
+
+The core library defines capabilities. They represent features common to various websites.
+For example, http://www.youtube.com and http://www.dailymotion.com are both videos
+providers: Weboob defines the ``ICapVideo`` capability.
+
+Each backend interfaces a website and implements one or many of these
+capabilities. Backends can be configured, which means that the end-user can
+provide personal information to access the underlaying website (login/password
+for example).
+
+Multi-backend call
+------------------
+
+The core library provides a mechanism allowing applications to call many backends in
+parallel, in a multi-threaded way.
+
+For example, one could search a video on many providers websites.
+
+Applications
+------------
+
+Applications are toolkit-agnostic. They can use Gtk, Qt or just be text-only, more adapted to reuse data through pipes.