X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=docs%2Fsource%2Findex.rst;h=468a3c911cb34b910328345d75c018c9354c6de5;hp=a3bc265475bf114671bcbdf46541bc6b9fb36f68;hb=2dd0cf8f5bbf63c0e0a423344de95e9d433bf7af;hpb=d2b4307851f184908bd8aa2217eb1a31f66f7cc7 diff --git a/docs/source/index.rst b/docs/source/index.rst index a3bc2654..468a3c91 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. 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|. More information on specific topics can be found on the following pages: (none here yet) Notmuch can be imported as:: @@ -45,10 +45,23 @@ or:: .. automethod:: get_path + .. automethod:: get_version + + .. automethod:: needs_upgrade + + .. automethod:: upgrade + + .. automethod:: get_directory + + .. automethod:: add_message + + .. automethod:: remove_message + .. automethod:: find_message .. automethod:: get_all_tags + .. automethod:: create_query .. attribute:: Database.MODE @@ -84,8 +97,12 @@ or:: .. automethod:: set_sort + .. automethod:: search_threads + .. automethod:: search_messages + .. automethod:: count_messages + :class:`Messages` -- A bunch of messages ---------------------------------------- @@ -99,7 +116,38 @@ or:: ---------------------------------------- .. autoclass:: Message - :members: + + .. automethod:: get_message_id + + .. automethod:: get_thread_id + + .. automethod:: get_replies + + .. automethod:: get_filename + + .. automethod:: get_flag + + .. automethod:: set_flag + + .. automethod:: get_date + + .. automethod:: get_header + + .. automethod:: get_tags + + .. automethod:: remove_tag + + .. automethod:: add_tag + + .. automethod:: remove_all_tags + + .. automethod:: freeze + + .. automethod:: thaw + + .. automethod:: format_as_text + + .. automethod:: __str__ :class:`Tags` -- Notmuch tags ----------------------------- @@ -111,6 +159,26 @@ or:: .. automethod:: __str__ +:class:`Threads` -- Threads iterator +------------------------------------ + +To be implemented + +:class:`Thread` -- A single thread +------------------------------------ + +To be implemented + +:class:`Filenames` -- An iterator over filenames +------------------------------------------------ + +To be implemented + +:class:`Directoy` -- A directory entry in the database +------------------------------------------------------ + +To be implemented + :exc:`NotmuchError` -- A Notmuch execution error ------------------------------------------------ .. autoexception:: NotmuchError @@ -121,7 +189,8 @@ or:: :class:`STATUS` -- Notmuch operation return status -------------------------------------------------- .. autoclass:: STATUS - :members: + + To be documented Indices and tables ==================