notmuch/bindings/python/docs/source/index.rst
Justus Winter 643719dfce python: remove the "notmuch binary" section from the docs
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-05-17 17:47:49 +02:00

36 lines
806 B
ReStructuredText

Welcome to :mod:`notmuch`'s documentation
=========================================
.. currentmodule:: notmuch
The :mod:`notmuch` module provides an interface to the `notmuch
<http://notmuchmail.org>`_ functionality, directly interfacing to a
shared notmuch library. Within :mod:`notmuch`, the classes
:class:`Database`, :class:`Query` provide most of the core
functionality, returning :class:`Threads`, :class:`Messages` and
:class:`Tags`.
.. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
:License: This module is covered under the GNU GPL v3 (or later).
.. toctree::
:maxdepth: 1
quickstart
notes
status_and_errors
database
query
messages
message
tags
threads
thread
filesystem
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`