diff options
| author | David Bremner <bremner@debian.org> | 2019-02-17 07:30:33 -0400 |
|---|---|---|
| committer | David Bremner <bremner@debian.org> | 2019-02-17 07:30:33 -0400 |
| commit | f7130468d27c4f37d45e6aa60baacfc3329ccff4 (patch) | |
| tree | f26a901f6e28185d60200c9111de30e1c15b4996 /bindings/python/docs/source/index.rst | |
Import notmuch_0.28.2.orig.tar.gz
[dgit import orig notmuch_0.28.2.orig.tar.gz]
Diffstat (limited to 'bindings/python/docs/source/index.rst')
| -rw-r--r-- | bindings/python/docs/source/index.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst new file mode 100644 index 00000000..bef7e60d --- /dev/null +++ b/bindings/python/docs/source/index.rst @@ -0,0 +1,36 @@ +Welcome to :mod:`notmuch`'s documentation +========================================= + +.. currentmodule:: notmuch + +The :mod:`notmuch` module provides an interface to the `notmuch +<https://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` |