implement Database.get_version() and Database.needs_upgrade()

[notmuch] / docs / source / index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index d6f9411dabbf162bf34df9a7ecb8eec233d82bd6..fc1d307e573d19ef2d5f4fbc82c61a1e2519852f 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -45,6 +45,18 @@ 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
@@ -62,33 +74,71 @@ or::
 
    .. autoattribute:: db_p
 
-:class:`Query` -- Represents a notmuch Query
+:class:`Query` -- A search query
 -----------------------------------------------
 
 .. autoclass:: Query
-   :members:
+
+   .. automethod:: create
+
+   .. attribute:: Query.SORT
+
+     Defines constants that are used as the mode in which to open a database.
+
+     SORT.OLDEST_FIRST
+       Sort by message date, oldest first.
+
+     SORT.NEWEST_FIRST
+       Sort by message date, newest first.
+
+     SORT.MESSAGE_ID
+       Sort by email message ID
+
+   .. automethod:: set_sort
+
+   .. automethod:: search_messages
 
 :class:`Messages` -- A bunch of messages
 ----------------------------------------
 
 .. autoclass:: Messages
-   :members:
+
+   .. automethod:: collect_tags
+
+   .. automethod:: __len__
 
 :class:`Message` -- A single message
 ----------------------------------------
 
 .. autoclass:: Message
-   :members:
 
-:class:`Tags` -- A bunch of notmuch tags
-----------------------------------------
+   .. automethod:: get_message_id
+
+   .. automethod:: get_date
+
+   .. automethod:: get_header
+
+   .. automethod:: get_filename
+
+   .. automethod:: get_tags
+
+   .. automethod:: remove_tag
+
+   .. automethod:: add_tag
+
+   .. automethod:: format_as_text
+
+   .. automethod:: __str__
+
+:class:`Tags` -- Notmuch tags
+-----------------------------
 
 .. autoclass:: Tags
    :members:
 
-   .. data: '__notmuchcmd__'
+   .. automethod:: __len__
 
-      This is the actual binary that will be executed in order to run a notmuch command. This is set to *notmuch* and should usually not be changed.
+   .. automethod:: __str__
 
 :exc:`NotmuchError` -- A Notmuch execution error
 ------------------------------------------------