python: move the notmuch module section to notes.rst

[notmuch] / bindings / python / docs / source / index.rst

diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst
index f7d3d6058e3b058a171da31a365d57b2b02abd0f..a2b42aae6b686ccd5da1357010a861de819c08f3 100644 (file)
--- a/bindings/python/docs/source/index.rst
+++ b/bindings/python/docs/source/index.rst
@@ -13,39 +13,23 @@ Within :mod:`notmuch`, the classes :class:`Database`, :class:`Query` provide mos
 
 :License: This module is covered under the GNU GPL v3 (or later).
 
-This page contains the main API overview of notmuch |release|. 
+This page contains the main API overview of notmuch |release|.
 
-Notmuch can be imported as::
-
- import notmuch
-
-or::
-
- from notmuch import Query, Database
-
- db = Database('path',create=True)
- msgs = Query(db,'from:myself').search_messages()
-
- for msg in msgs:
-    print (msg)
 
 More information on specific topics can be found on the following pages:
 
 .. toctree::
    :maxdepth: 1
 
+   quickstart
+   notes
    status_and_errors
-   notmuch   
-
-:mod:`notmuch` -- The Notmuch interface
-=================================================
+   notmuch
 
-.. automodule:: notmuch
-
-:class:`notmuch.Database` -- The underlying notmuch database
+:class:`Database` -- The underlying notmuch database
 ---------------------------------------------------------------------
 
-.. autoclass:: notmuch.Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
+.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
 
    .. automethod:: create
 
@@ -90,10 +74,10 @@ More information on specific topics can be found on the following pages:
    .. autoattribute:: db_p
 
 
-:class:`notmuch.Query` -- A search query
+:class:`Query` -- A search query
 -------------------------------------------------
 
-.. autoclass:: notmuch.Query
+.. autoclass:: Query
 
    .. automethod:: create
 
@@ -111,8 +95,8 @@ More information on specific topics can be found on the following pages:
        Sort by email message ID.
 
      SORT.UNSORTED
-       Do not apply a special sort order (returns results in document id     
-       order). 
+       Do not apply a special sort order (returns results in document id
+       order).
 
    .. automethod:: set_sort
 
@@ -128,6 +112,8 @@ More information on specific topics can be found on the following pages:
 
    .. automethod:: count_messages
 
+   .. automethod:: count_threads
+
 
 :class:`Messages` -- A bunch of messages
 ----------------------------------------
@@ -139,7 +125,7 @@ More information on specific topics can be found on the following pages:
    .. method:: __len__()
 
    .. warning::
-   
+
       :meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke
       list(Messages()). Use the :meth:`Query.count_messages` function or use `len(list(msgs))`.
 
@@ -160,7 +146,7 @@ More information on specific topics can be found on the following pages:
 
    .. attribute:: FLAG
 
-        FLAG.MATCH 
+        FLAG.MATCH
           This flag is automatically set by a
          Query.search_threads on those messages that match the
          query. This allows us to distinguish matches from the rest
@@ -169,7 +155,7 @@ More information on specific topics can be found on the following pages:
    .. automethod:: get_flag
 
    .. automethod:: set_flag
-   
+
    .. automethod:: get_date
 
    .. automethod:: get_header
@@ -214,10 +200,10 @@ More information on specific topics can be found on the following pages:
    .. automethod:: __str__
 
 
-:class:`notmuch.Threads` -- Threads iterator
+:class:`Threads` -- Threads iterator
 -----------------------------------------------------
 
-.. autoclass:: notmuch.Threads
+.. autoclass:: Threads
 
    .. automethod:: __len__
 
@@ -252,26 +238,28 @@ More information on specific topics can be found on the following pages:
 :class:`Filenames` -- An iterator over filenames
 ------------------------------------------------
 
-.. autoclass:: notmuch.database.Filenames
+.. autoclass:: Filenames
+
+   .. automethod:: Filenames.__len__
 
-   .. automethod:: notmuch.database.Filenames.__len__
+   .. automethod:: Filenames.as_generator
 
-:class:`notmuch.database.Directoy` -- A directory entry in the database
+:class:`Directoy` -- A directory entry in the database
 ------------------------------------------------------------------------
 
-.. autoclass:: notmuch.database.Directory
+.. autoclass:: Directory
 
-   .. automethod:: notmuch.database.Directory.get_child_files
+   .. automethod:: Directory.get_child_files
 
-   .. automethod:: notmuch.database.Directory.get_child_directories
+   .. automethod:: Directory.get_child_directories
 
-   .. automethod:: notmuch.database.Directory.get_mtime
+   .. automethod:: Directory.get_mtime
 
-   .. automethod:: notmuch.database.Directory.set_mtime
+   .. automethod:: Directory.set_mtime
 
-   .. autoattribute:: notmuch.database.Directory.mtime
+   .. autoattribute:: Directory.mtime
 
-   .. autoattribute:: notmuch.database.Directory.path
+   .. autoattribute:: Directory.path
 
 
 The `next page <status_and_errors.html>`_ contains information on possible Status and Error values.