X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=docs%2Fsource%2Findex.rst;h=f2b995a63ca6fb8062d548543ef111d92ccaf919;hp=468a3c911cb34b910328345d75c018c9354c6de5;hb=bb57345740da993584794d4071c63294da7beaa8;hpb=f3cfa749c1df0f30832f59483b55160ab8a95ca6 diff --git a/docs/source/index.rst b/docs/source/index.rst index 468a3c91..f2b995a6 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -13,7 +13,7 @@ The classes :class:`notmuch.Database`, :class:`notmuch.Query` provide most of th :License: This module is covered under the GNU GPL v3 (or later). -This page contains the main API overview of cnotmuch |release|. More information on specific topics can be found on the following pages: (none here yet) +This page contains the main API overview of cnotmuch |release|. Notmuch can be imported as:: @@ -23,9 +23,12 @@ or:: from cnotmuch.notmuch import Query,Database +More information on specific topics can be found on the following pages: + .. toctree:: :maxdepth: 1 + notmuch :mod:`notmuch` -- The Notmuch interface ============================================= @@ -63,6 +66,9 @@ or:: .. automethod:: create_query + .. note:: :meth:`create_query` was broken in release + 0.1 and is fixed since 0.1.1. + .. attribute:: Database.MODE Defines constants that are used as the mode in which to open a database. @@ -97,6 +103,12 @@ or:: .. automethod:: set_sort + .. attribute:: sort + + Instance attribute :attr:`sort` contains the sort order (see + :attr:`Query.SORT`) if explicitely specified via + :meth:`set_sort`. By default it is set to `None`. + .. automethod:: search_threads .. automethod:: search_messages @@ -159,15 +171,43 @@ or:: .. automethod:: __str__ + +.. ----------------------------------------------------------------- +.. currentmodule:: cnotmuch.thread + :class:`Threads` -- Threads iterator ------------------------------------ -To be implemented +.. autoclass:: Threads + + .. automethod:: __len__ + + .. automethod:: __str__ :class:`Thread` -- A single thread ------------------------------------ -To be implemented +.. autoclass:: Thread + + .. automethod:: get_thread_id + + .. automethod:: get_total_messages + + .. automethod:: get_toplevel_messages + + .. automethod:: get_matched_messages + + .. automethod:: get_authors + + .. automethod:: get_subject + + .. automethod:: get_oldest_date + + .. automethod:: get_newest_date + + .. automethod:: get_tags + + .. automethod:: __str__ :class:`Filenames` -- An iterator over filenames ------------------------------------------------