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 e87a865947bdf8720d4a4d7692ebfd295b2c47d7..a2b42aae6b686ccd5da1357010a861de819c08f3 100644 (file)
--- a/bindings/python/docs/source/index.rst
+++ b/bindings/python/docs/source/index.rst
@@ -15,37 +15,21 @@ Within :mod:`notmuch`, the classes :class:`Database`, :class:`Query` provide mos
 
 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
-=================================================
-
-.. 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
 
@@ -216,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__
 
@@ -254,28 +238,28 @@ More information on specific topics can be found on the following pages:
 :class:`Filenames` -- An iterator over filenames
 ------------------------------------------------
 
-.. autoclass:: notmuch.Filenames
+.. autoclass:: Filenames
 
-   .. automethod:: notmuch.Filenames.__len__
+   .. automethod:: Filenames.__len__
 
-   .. automethod:: notmuch.Filenames.as_generator
+   .. automethod:: Filenames.as_generator
 
-:class:`notmuch.database.Directoy` -- A directory entry in the database
+:class:`Directoy` -- A directory entry in the database
 ------------------------------------------------------------------------
 
-.. autoclass:: notmuch.Directory
+.. autoclass:: Directory
 
-   .. automethod:: notmuch.Directory.get_child_files
+   .. automethod:: Directory.get_child_files
 
-   .. automethod:: notmuch.Directory.get_child_directories
+   .. automethod:: Directory.get_child_directories
 
-   .. automethod:: notmuch.Directory.get_mtime
+   .. automethod:: Directory.get_mtime
 
-   .. automethod:: notmuch.Directory.set_mtime
+   .. automethod:: Directory.set_mtime
 
-   .. autoattribute:: notmuch.Directory.mtime
+   .. autoattribute:: Directory.mtime
 
-   .. autoattribute:: notmuch.Directory.path
+   .. autoattribute:: Directory.path
 
 
 The `next page <status_and_errors.html>`_ contains information on possible Status and Error values.