mirror of
https://github.com/OfflineIMAP/offlineimap.git
synced 2024-06-29 07:50:51 +02:00
74b133c500
`make` in the `docs` dir or `make doc` in the root dir will now create the 1) man page and 2) the user documentation using sphinx (requiring python-doctools, and sphinx). The resulting user docs are in `docs/html`. You can also only create the man pages with `make man` in the `docs` dir. Also fixed all .rst conversion errors as requested by Gentoo downstream. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
28 lines
857 B
ReStructuredText
28 lines
857 B
ReStructuredText
:mod:`offlineimap.ui` -- A flexible logging system
|
|
--------------------------------------------------------
|
|
|
|
.. currentmodule:: offlineimap.ui
|
|
|
|
OfflineImap has various ui systems, that can be selected. They offer various functionalities. They must implement all functions that the :class:`offlineimap.ui.UIBase` offers. Early on, the ui must be set using :meth:`getglobalui`
|
|
|
|
.. automethod:: offlineimap.ui.setglobalui
|
|
.. automethod:: offlineimap.ui.getglobalui
|
|
|
|
Base UI plugin
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: offlineimap.ui.UIBase.UIBase
|
|
:members:
|
|
:inherited-members:
|
|
|
|
.. .. note:: :meth:`foo`
|
|
.. .. attribute:: Database.MODE
|
|
|
|
Defines constants that are used as the mode in which to open a database.
|
|
|
|
MODE.READ_ONLY
|
|
Open the database in read-only mode
|
|
|
|
MODE.READ_WRITE
|
|
Open the database in read-write mode
|