From b21d0a104b3bd38bd32bf1448026f2f63d96a28a Mon Sep 17 00:00:00 2001 From: Christophe Benz Date: Thu, 25 Nov 2010 16:07:45 +0100 Subject: [PATCH] create doc skeleton --- docs/source/api/core/backendscfg.rst | 6 ++++ docs/source/api/core/bcall.rst | 6 ++++ docs/source/api/core/index.rst | 13 ++++++++ docs/source/api/core/modules.rst | 6 ++++ docs/source/api/core/ouiboube.rst | 6 ++++ docs/source/api/core/scheduler.rst | 6 ++++ docs/source/api/index.rst | 10 +++++++ docs/source/api/tools/backend.rst | 6 ++++ docs/source/api/tools/index.rst | 9 ++++++ docs/source/applications.rst | 5 ++++ docs/source/backends.rst | 5 ++++ docs/source/guides/application.rst | 2 ++ docs/source/guides/backend.rst | 2 ++ docs/source/guides/index.rst | 10 +++++++ docs/source/index.rst | 19 ++++++++---- docs/source/install.rst | 30 +++++++++++++++++++ docs/source/overview.rst | 44 ++++++++++++++++++++++++++++ 17 files changed, 179 insertions(+), 6 deletions(-) create mode 100644 docs/source/api/core/backendscfg.rst create mode 100644 docs/source/api/core/bcall.rst create mode 100644 docs/source/api/core/index.rst create mode 100644 docs/source/api/core/modules.rst create mode 100644 docs/source/api/core/ouiboube.rst create mode 100644 docs/source/api/core/scheduler.rst create mode 100644 docs/source/api/index.rst create mode 100644 docs/source/api/tools/backend.rst create mode 100644 docs/source/api/tools/index.rst create mode 100644 docs/source/applications.rst create mode 100644 docs/source/backends.rst create mode 100644 docs/source/guides/application.rst create mode 100644 docs/source/guides/backend.rst create mode 100644 docs/source/guides/index.rst create mode 100644 docs/source/install.rst create mode 100644 docs/source/overview.rst diff --git a/docs/source/api/core/backendscfg.rst b/docs/source/api/core/backendscfg.rst new file mode 100644 index 00000000..b26f8a9b --- /dev/null +++ b/docs/source/api/core/backendscfg.rst @@ -0,0 +1,6 @@ +:mod:`weboob.core.backendscfg` +============================== + +.. automodule:: weboob.core.backendscfg + :members: + :undoc-members: diff --git a/docs/source/api/core/bcall.rst b/docs/source/api/core/bcall.rst new file mode 100644 index 00000000..51d173f3 --- /dev/null +++ b/docs/source/api/core/bcall.rst @@ -0,0 +1,6 @@ +:mod:`weboob.core.bcall` +======================== + +.. automodule:: weboob.core.bcall + :members: + :undoc-members: diff --git a/docs/source/api/core/index.rst b/docs/source/api/core/index.rst new file mode 100644 index 00000000..fd1dc575 --- /dev/null +++ b/docs/source/api/core/index.rst @@ -0,0 +1,13 @@ +:mod:`weboob.core` +================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + backendscfg + bcall + modules + ouiboube + scheduler diff --git a/docs/source/api/core/modules.rst b/docs/source/api/core/modules.rst new file mode 100644 index 00000000..60ea3d14 --- /dev/null +++ b/docs/source/api/core/modules.rst @@ -0,0 +1,6 @@ +:mod:`weboob.core.modules` +========================== + +.. automodule:: weboob.core.modules + :members: + :undoc-members: diff --git a/docs/source/api/core/ouiboube.rst b/docs/source/api/core/ouiboube.rst new file mode 100644 index 00000000..72e57cdc --- /dev/null +++ b/docs/source/api/core/ouiboube.rst @@ -0,0 +1,6 @@ +:mod:`weboob.core.ouiboube` +=========================== + +.. automodule:: weboob.core.ouiboube + :members: + :undoc-members: diff --git a/docs/source/api/core/scheduler.rst b/docs/source/api/core/scheduler.rst new file mode 100644 index 00000000..10634f39 --- /dev/null +++ b/docs/source/api/core/scheduler.rst @@ -0,0 +1,6 @@ +:mod:`weboob.core.scheduler` +============================ + +.. automodule:: weboob.core.scheduler + :members: + :undoc-members: diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst new file mode 100644 index 00000000..6523b659 --- /dev/null +++ b/docs/source/api/index.rst @@ -0,0 +1,10 @@ +API +=== + +Contents: + +.. toctree:: + :maxdepth: 2 + + core/index + tools/index diff --git a/docs/source/api/tools/backend.rst b/docs/source/api/tools/backend.rst new file mode 100644 index 00000000..b0792159 --- /dev/null +++ b/docs/source/api/tools/backend.rst @@ -0,0 +1,6 @@ +:mod:`weboob.tools.backend` +=========================== + +.. automodule:: weboob.tools.backend + :members: + :undoc-members: diff --git a/docs/source/api/tools/index.rst b/docs/source/api/tools/index.rst new file mode 100644 index 00000000..0489b9f7 --- /dev/null +++ b/docs/source/api/tools/index.rst @@ -0,0 +1,9 @@ +:mod:`weboob.tools` +=================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + backend diff --git a/docs/source/applications.rst b/docs/source/applications.rst new file mode 100644 index 00000000..52d84b90 --- /dev/null +++ b/docs/source/applications.rst @@ -0,0 +1,5 @@ +Applications +============ + +boobank +------- diff --git a/docs/source/backends.rst b/docs/source/backends.rst new file mode 100644 index 00000000..87ad3a8f --- /dev/null +++ b/docs/source/backends.rst @@ -0,0 +1,5 @@ +Backends +======== + +cragr +----- diff --git a/docs/source/guides/application.rst b/docs/source/guides/application.rst new file mode 100644 index 00000000..907d4050 --- /dev/null +++ b/docs/source/guides/application.rst @@ -0,0 +1,2 @@ +Application development +======================= diff --git a/docs/source/guides/backend.rst b/docs/source/guides/backend.rst new file mode 100644 index 00000000..4b649501 --- /dev/null +++ b/docs/source/guides/backend.rst @@ -0,0 +1,2 @@ +Backend development +=================== diff --git a/docs/source/guides/index.rst b/docs/source/guides/index.rst new file mode 100644 index 00000000..bad6c9ff --- /dev/null +++ b/docs/source/guides/index.rst @@ -0,0 +1,10 @@ +Guides +====== + +Contents: + +.. toctree:: + :maxdepth: 2 + + application + backend diff --git a/docs/source/index.rst b/docs/source/index.rst index 608f9eb3..db331271 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,16 +1,23 @@ -.. Weboob documentation master file, created by - 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. +Weboob +====== -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 ================== diff --git a/docs/source/install.rst b/docs/source/install.rst new file mode 100644 index 00000000..62fef4f0 --- /dev/null +++ b/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`` diff --git a/docs/source/overview.rst b/docs/source/overview.rst new file mode 100644 index 00000000..50656886 --- /dev/null +++ b/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 ` providing all the features needed by backends +* :doc:`tools ` 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.