fix documentations, and add a very brittle notmuch reply command

[notmuch] / docs / source / index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index a3bc265475bf114671bcbdf46541bc6b9fb36f68..4a6c574bdc85a8e1952be76f29b16d8fc8f7b5b2 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -7,13 +7,13 @@ Welcome to :mod:`cnotmuch`'s documentation
 ===========================================
 
 The :mod:`cnotmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ 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 <Sebastian@SSpaeth.de>
 
 :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|. 
 
 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
 =============================================
@@ -45,10 +48,26 @@ 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
+
+   .. note:: :meth:`create_query` was broken in release
+             0.1 and is fixed since 0.1.1.
 
    .. attribute:: Database.MODE
 
@@ -84,8 +103,21 @@ 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
 
+   .. automethod:: count_messages
+
+.. #############################################
+.. currentmodule:: cnotmuch.message
+
 :class:`Messages` -- A bunch of messages
 ----------------------------------------
 
@@ -99,7 +131,41 @@ 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__
+
+.. #############################################
+.. currentmodule:: cnotmuch.tag
 
 :class:`Tags` -- Notmuch tags
 -----------------------------
@@ -111,6 +177,57 @@ or::
 
    .. automethod:: __str__
 
+
+.. #############################################
+.. currentmodule:: cnotmuch.thread
+
+:class:`Threads` -- Threads iterator
+------------------------------------
+
+.. autoclass:: Threads
+
+   .. automethod:: __len__
+
+   .. automethod:: __str__
+
+:class:`Thread` -- A single thread
+------------------------------------
+
+.. 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__
+
+.. #############################################
+.. currentmodule:: cnotmuch.notmuch
+
+: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 +238,8 @@ or::
 :class:`STATUS` -- Notmuch operation return status
 --------------------------------------------------
 .. autoclass:: STATUS
-   :members:
+
+   To be documented
 
 Indices and tables
 ==================