summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2014-08-25 21:03:17 -0500
committerKali Kaneko <kali@leap.se>2014-08-25 21:03:17 -0500
commita9389c17bb695e4b4b4de176f085bcdd2d21fbbc (patch)
tree1b84391a06f2a52caba2ecd7c98f3bcfb8799ab3 /docs/index.rst
parent804a0b388a8d0fc4e03ec2c525f277d5eabaae7f (diff)
sphinx documentation for the mail library
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..4801833
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,66 @@
+.. leap.mail documentation master file, created by
+ sphinx-quickstart on Mon Aug 25 19:19:48 2014.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to leap.mail's documentation!
+=====================================
+
+This is the documentation for the ``leap.imap`` module. It is a twisted package
+that exposes two services, ``smtp`` and ``imap``, that run local proxies and interact
+with a remote ``LEAP`` provider that offers *a soledad syncronization endpoint*
+and receive the outgoing email.
+
+See :ref:`the life cycle of a leap email <mail_journey>` for an overview of the life cycle
+of an email through ``LEAP`` providers.
+
+``Soledad`` stores its documents as local ``sqlcipher`` tables, and syncs
+against the soledad sync service in the provider.
+
+
+.. TODO clear document types documentation.
+
+The data model at the present moment consists of several *document types* that split email into
+different documents that are stored in ``Soledad``. The idea behind this is to
+keep clear the separation between *mutable* and *inmutable* parts, and still being able to
+reconstruct arbitrarily nested email structures easily.
+
+In the coming releases we are going to be working towards the goal of exposing
+a protocol-agnostic email public API, so that third party mail clients can
+manipulate the data layer without having to resort to handling the sql tables or
+doing direct u1db calls. The code will be transitioning towards a LEAPMail
+public API that we can stabilize as soon as possible, and leaving the IMAP
+server as another code entity that uses this lower layer.
+
+
+..
+.. Contents:
+.. toctree::
+ :maxdepth: 2
+
+.. intro
+.. tutorial
+
+
+API documentation
+-----------------
+
+If you were looking for the documentation of the ``leap.mail`` module, you will
+find it here. Beware that the public API will still be unstable for the next
+development cycles.
+
+.. toctree::
+ :maxdepth: 2
+
+ api/mail
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+