X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=docs%2Fsource%2Findex.rst;h=4a6c574bdc85a8e1952be76f29b16d8fc8f7b5b2;hp=f2b995a63ca6fb8062d548543ef111d92ccaf919;hb=9058e3d1b55ed35cda2df6426578435934af19de;hpb=bb57345740da993584794d4071c63294da7beaa8 diff --git a/docs/source/index.rst b/docs/source/index.rst index f2b995a6..4a6c574b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,7 +7,7 @@ Welcome to :mod:`cnotmuch`'s documentation =========================================== The :mod:`cnotmuch` module provides an interface to the `notmuch `_ functionality, directly interfacing to a shared notmuch library. -The classes :class:`notmuch.Database`, :class:`notmuch.Query` provide most of the core functionality, returning :class:`notmuch.Messages` and :class:`notmuch.Tags`. +The classes :class:`notmuch.Database`, :class:`notmuch.Query` provide most of the core functionality, returning :class:`notmuch.Threads`, :class:`notmuch.Messages` and :class:`notmuch.Tags`. .. moduleauthor:: Sebastian Spaeth @@ -115,6 +115,9 @@ More information on specific topics can be found on the following pages: .. automethod:: count_messages +.. ############################################# +.. currentmodule:: cnotmuch.message + :class:`Messages` -- A bunch of messages ---------------------------------------- @@ -161,6 +164,9 @@ More information on specific topics can be found on the following pages: .. automethod:: __str__ +.. ############################################# +.. currentmodule:: cnotmuch.tag + :class:`Tags` -- Notmuch tags ----------------------------- @@ -172,7 +178,7 @@ More information on specific topics can be found on the following pages: .. automethod:: __str__ -.. ----------------------------------------------------------------- +.. ############################################# .. currentmodule:: cnotmuch.thread :class:`Threads` -- Threads iterator @@ -209,6 +215,9 @@ More information on specific topics can be found on the following pages: .. automethod:: __str__ +.. ############################################# +.. currentmodule:: cnotmuch.notmuch + :class:`Filenames` -- An iterator over filenames ------------------------------------------------