tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Integrate SubmittingPatches.rst into HACKING.rst

Browse Source 
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
This commit is contained in:
Sebastian Spaeth
2012-02-24 12:03:56 +01:00
parent ae85b666d4
commit 8bbdaa8c66
4 changed files with 216 additions and 219 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/doc-src/API.rst
View File

@ -2,8 +2,10 @@
.. currentmodule:: offlineimap
Welcome to :mod:`offlineimaps`'s documentation
==============================================
.. _API docs:
:mod:`offlineimap's` API 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`.