git.notmuchmail.org Git - notmuch/blob - bindings/python/docs/source/index.rst

   1 Welcome to :mod:`notmuch`'s documentation
   2 =========================================
   3
   4 .. currentmodule:: notmuch
   5
   6 The :mod:`notmuch` module provides an interface to the `notmuch
   7 <https://notmuchmail.org>`_ functionality, directly interfacing to a
   8 shared notmuch library.  Within :mod:`notmuch`, the classes
   9 :class:`Database`, :class:`Query` provide most of the core
  10 functionality, returning :class:`Threads`, :class:`Messages` and
  11 :class:`Tags`.
  12
  13 .. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
  14
  15 :License: This module is covered under the GNU GPL v3 (or later).
  16
  17 .. toctree::
  18    :maxdepth: 1
  19
  20    quickstart
  21    notes
  22    status_and_errors
  23    database
  24    query
  25    messages
  26    message
  27    tags
  28    threads
  29    thread
  30    filesystem
  31
  32 Indices and tables
  33 ==================
  34
  35 * :ref:`genindex`
  36 * :ref:`search`