mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-22 19:08:09 +01:00
d50171d1cc
Move each classes documentation into its own file and thus into its own page in the generated documentation. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
37 lines
817 B
ReStructuredText
37 lines
817 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
|
|
notmuch
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|