Make __VERSION__ available via cnotmuch.notmuch.__VERSION__ and improve README

[notmuch] / docs / source / index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 5b262bba60af1d2d9f756dcf1b9dc2f8eab4148e..468a3c911cb34b910328345d75c018c9354c6de5 100644 (file)
--- 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
 ----------------------------------------
 
@@ -102,18 +119,32 @@ or::
 
    .. automethod:: get_message_id
 
-   .. automethod:: get_date
+   .. automethod:: get_thread_id
 
-   .. automethod:: get_header
+   .. 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__
@@ -128,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
@@ -138,7 +189,8 @@ or::
 :class:`STATUS` -- Notmuch operation return status
 --------------------------------------------------
 .. autoclass:: STATUS
-   :members:
+
+   To be documented
 
 Indices and tables
 ==================