Improve documentation
Improve wording, and integrate the MANUAL and INSTALL and FAQ documents into our complete user manual that is hosted online. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
This commit is contained in:
Sebastian Spaeth
55
docs/dev-doc-src/API.rst
Normal file
55
docs/dev-doc-src/API.rst
Normal file
@@ -0,0 +1,55 @@
|
||||
.. OfflineImap API documentation
|
||||
|
||||
.. currentmodule:: offlineimap
|
||||
|
||||
Welcome to :mod:`offlineimaps`'s documentation
|
||||
==============================================
|
||||
|
||||
Within :mod:`offlineimap`, the classes :class:`OfflineImap` provides the high-level functionality. The rest of the classes should usually not needed to be touched by the user. Email repositories are represented by a :class:`offlineimap.repository.Base.BaseRepository` or derivatives (see :mod:`offlineimap.repository` for details). A folder within a repository is represented by a :class:`offlineimap.folder.Base.BaseFolder` or any derivative from :mod:`offlineimap.folder`.
|
||||
|
||||
This page contains the main API overview of OfflineImap |release|.
|
||||
|
||||
OfflineImap can be imported as::
|
||||
|
||||
from offlineimap import OfflineImap
|
||||
|
||||
:mod:`offlineimap` -- The OfflineImap module
|
||||
=============================================
|
||||
|
||||
.. module:: offlineimap
|
||||
|
||||
.. autoclass:: offlineimap.OfflineImap(cmdline_opts = None)
|
||||
|
||||
|
||||
.. automethod:: run
|
||||
|
||||
.. automethod:: parse_cmd_options
|
||||
|
||||
.. .. autoattribute:: ui
|
||||
|
||||
:todo: Document
|
||||
|
||||
:class:`offlineimap.account`
|
||||
============================
|
||||
|
||||
An :class:`accounts.Account` connects two email repositories that are to be synced. It comes in two flavors, normal and syncable.
|
||||
|
||||
.. autoclass:: offlineimap.accounts.Account
|
||||
|
||||
.. autoclass:: offlineimap.accounts.SyncableAccount
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
.. autodata:: ui
|
||||
|
||||
Contains the current :mod:`offlineimap.ui`, and can be used for logging etc.
|
||||
|
||||
:exc:`OfflineImapError` -- A Notmuch execution error
|
||||
--------------------------------------------------------
|
||||
|
||||
.. autoexception:: offlineimap.error.OfflineImapError
|
||||
:members:
|
||||
|
||||
This execption inherits directly from :exc:`Exception` and is raised
|
||||
on errors during the offlineimap execution. It has an attribute
|
||||
`severity` that denotes the severity level of the error.
|
||||
1
docs/dev-doc-src/FAQ.rst
Symbolic link
1
docs/dev-doc-src/FAQ.rst
Symbolic link
@@ -0,0 +1 @@
|
||||
../FAQ.rst
|
||||
1
docs/dev-doc-src/INSTALL.rst
Symbolic link
1
docs/dev-doc-src/INSTALL.rst
Symbolic link
@@ -0,0 +1 @@
|
||||
../INSTALL.rst
|
||||
1
docs/dev-doc-src/MANUAL.rst
Symbolic link
1
docs/dev-doc-src/MANUAL.rst
Symbolic link
@@ -0,0 +1 @@
|
||||
../MANUAL.rst
|
||||
@@ -94,7 +94,7 @@ pygments_style = 'sphinx'
|
||||
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
||||
html_theme = 'default'
|
||||
|
||||
#html_style = ''
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
|
||||
@@ -1,69 +1,42 @@
|
||||
.. OfflineImap documentation master file
|
||||
.. _OfflineImap: http://offlineimap.org
|
||||
|
||||
.. currentmodule:: offlineimap
|
||||
|
||||
Welcome to :mod:`offlineimaps`'s documentation
|
||||
==============================================
|
||||
|
||||
The :mod:`offlineimap` module provides the user interface for synchronization between IMAP servers and MailDirs or between IMAP servers. The homepage containing the source code repository can be found at the `offlineimap homepage <http://offlineimap.org>`_. The following provides the developer documentation for those who are interested in modifying the source code or otherwise peek into the OfflineImap internals. End users might want to check the MANUAL, our INSTALLation instructions, and the FAQ.
|
||||
`OfflineImap`_ synchronizes email between an IMAP server and a MailDir or between two IMAP servers. It offers very powerful and flexible configuration options, that allow things such as the filtering of folders, transposing of names via static configuration or python scripting. It plays well with mutt and other MailDir consuming email clients.
|
||||
|
||||
The documentation contains the end user documentation in a first part. It also contains use cases and example configurations. It is followed by the internal :doc:`API documentation <API>` for those interested in modifying the source code or otherwise peek into the OfflineImap internals in a second part.
|
||||
|
||||
|
||||
If you just want to get started with minimal fuzz, have a look at our `online quick start guide <http://offlineimap.org/#ref-quick-start>`_. Do note though, that our configuration options are many and powerful. Perusing our precious documentation does often pay off!
|
||||
|
||||
More information on specific topics can be found on the following pages:
|
||||
|
||||
**User documentation**
|
||||
* :doc:`installation/uninstall <INSTALL>`
|
||||
* :doc:`user manual/Configuration <MANUAL>`
|
||||
* :doc:`command line options <offlineimap>`
|
||||
* :doc:`Frequently Asked Questions <FAQ>`
|
||||
|
||||
**Developer documentation**
|
||||
* :doc:`API documentation <API>` for internal details on the
|
||||
:mod:`offlineimap` module
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
INSTALL
|
||||
MANUAL
|
||||
offlineimap
|
||||
FAQ
|
||||
|
||||
API
|
||||
repository
|
||||
ui
|
||||
|
||||
Within :mod:`offlineimap`, the classes :class:`OfflineImap` provides the high-level functionality. The rest of the classes should usually not needed to be touched by the user. Email repositories are represented by a :class:`offlineimap.repository.Base.BaseRepository` or derivatives (see :mod:`offlineimap.repository` for details). A folder within a repository is represented by a :class:`offlineimap.folder.Base.BaseFolder` or any derivative from :mod:`offlineimap.folder`.
|
||||
|
||||
.. moduleauthor:: John Goerzen, and many others. See AUTHORS and the git history for a full list.
|
||||
|
||||
:License: This module is covered under the GNU GPL v2 (or later).
|
||||
|
||||
This page contains the main API overview of OfflineImap |release|.
|
||||
|
||||
OfflineImap can be imported as::
|
||||
|
||||
from offlineimap import OfflineImap
|
||||
|
||||
More information on specific topics can be found on the following pages:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
repository
|
||||
ui
|
||||
offlineimap
|
||||
|
||||
:mod:`offlineimap` -- The OfflineImap module
|
||||
=============================================
|
||||
|
||||
.. module:: offlineimap
|
||||
|
||||
.. autoclass:: offlineimap.OfflineImap(cmdline_opts = None)
|
||||
|
||||
.. automethod:: lock
|
||||
|
||||
.. automethod:: run
|
||||
|
||||
.. .. autoattribute:: ui
|
||||
|
||||
:todo: Document
|
||||
|
||||
:class:`offlineimap.account`
|
||||
============================
|
||||
|
||||
An :class:`accounts.Account` connects two email repositories that are to be synced. It comes in two flavors, normal and syncable.
|
||||
|
||||
.. autoclass:: offlineimap.accounts.Account
|
||||
|
||||
.. autoclass:: offlineimap.accounts.SyncableAccount
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
.. autodata:: ui
|
||||
|
||||
Contains the current :mod:`offlineimap.ui`, and can be used for logging etc.
|
||||
|
||||
:exc:`OfflineImapError` -- A Notmuch execution error
|
||||
--------------------------------------------------------
|
||||
|
||||
.. autoexception:: offlineimap.error.OfflineImapError
|
||||
:members:
|
||||
|
||||
This execption inherits directly from :exc:`Exception` and is raised
|
||||
on errors during the offlineimap execution. It has an attribute
|
||||
`severity` that denotes the severity level of the error.
|
||||
|
||||
Reference in New Issue
Block a user