diff --git a/docs/source/_templates/indexcontent.html b/docs/source/_templates/indexcontent.html index ee48cb7d..9ef9bae9 100644 --- a/docs/source/_templates/indexcontent.html +++ b/docs/source/_templates/indexcontent.html @@ -5,6 +5,44 @@

This is the developer documentation. If you are not a developer and you are looking for information about the project, check the official website.

+

Hello world:

+ + +
+
>>> from weboob.core import Weboob
+>>> from weboob.capabilities.bank import CapBank
+>>> w = Weboob()
+>>> w.load_backends(CapBank)
+{'societegenerale': <Backend 'societegenerale'>, 'creditmutuel': <Backend 'creditmutuel'>}
+>>> pprint(list(w.iter_accounts()))
+[<Account id='7418529638527412' label=u'Compte de ch\xe8ques'>,
+ <Account id='9876543216549871' label=u'Livret A'>,
+ <Account id='123456789123456789123EUR' label=u'C/C Eurocompte Confort M Roger Philibert'>]
+>>> acc = next(iter(w.iter_accounts()))
+>>> acc.balance
+Decimal('87.32')
+
+
+
+
+ +

Concepts:

+ + +
+ + + + + + +
+

Guides:

diff --git a/docs/source/_templates/indexsidebar.html b/docs/source/_templates/indexsidebar.html index 01d397bd..745d730b 100644 --- a/docs/source/_templates/indexsidebar.html +++ b/docs/source/_templates/indexsidebar.html @@ -3,5 +3,5 @@
  • Official website
  • Bug Tracker
  • Roadmap
  • -
  • Download sources
  • +
  • Download stable version
  • diff --git a/docs/source/conf.py b/docs/source/conf.py index ad4c052c..ddaff65c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -36,7 +36,7 @@ source_suffix = '.rst' #source_encoding = 'utf-8' # The master toctree document. -master_doc = 'index' +#master_doc = 'index' # General information about the project. project = u'Weboob' diff --git a/docs/source/guides/setup.rst b/docs/source/guides/setup.rst index 26853133..cb45209e 100644 --- a/docs/source/guides/setup.rst +++ b/docs/source/guides/setup.rst @@ -38,7 +38,7 @@ Then, run this command:: $ weboob-config update Run Weboob without installation ------------------------------- +------------------------------- This does not actually install anything, but lets you run Weboob from the source code, while also using the modules from that source:: diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index 40aed08e..00000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -Weboob -====== - -Weboob (Web Outside Of Browsers) provides: - -* :doc:`applications ` to interact with websites -* :doc:`modules `, 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 AGPLv3+ license. - -.. note:: - This is the developer documentation. If you are not a developer and you are looking for information about the project, check the `official website `_. - -.. toctree:: - :maxdepth: 2 - - overview - guides/index - api/index - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs/source/overview.rst b/docs/source/overview.rst deleted file mode 100644 index 099d230c..00000000 --- a/docs/source/overview.rst +++ /dev/null @@ -1,52 +0,0 @@ -Overview -======== - -Weboob (`Web Outside Of Browsers`) provides: - -* :doc:`applications ` to interact with websites -* :doc:`modules `, 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 AGPLv3+ license. - -Architecture ------------- - -.. warning:: - This diagram has to be redrawn. - -.. image:: _static/architecture.png - -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 ``CapVideo`` capability. - -Each module interfaces a website and implements one or many of these -capabilities. Modules can be configured, which means that the end-user can -provide personal information to access the underlaying website (login/password -for example). We call a configured module a Backend. - -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. - -Reporting a bug ---------------- - -When you report a bug on the tracker, it's important to correctly set the category as specific as possible. -Also, don't forget to give information about your version of Weboob, OS, implicated libraries. - -It is often relevant to use the -d parameter on application to get verbose logs.