diff options
| author |  Justus Winter <4winter@informatik.uni-hamburg.de> | 2012-02-24 01:18:54 +0100 |
|---|---|---|
| committer | Justus Winter <4winter@informatik.uni-hamburg.de> | 2012-02-24 01:18:54 +0100 |
| commit | 8dfbba05fa43013e9c97d94246c167c3d64a9d50 (patch) | |
| tree | bc803e5212deef67a9b5df6734230fdf653d479a | |
| parent | fb52083bf7eff44f27b2f2fffcbfbcb4faaeda3c (diff) | |
python: move the usage example to quickstart.rst
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
| -rw-r--r-- | bindings/python/docs/source/index.rst | 14 | ||||
| -rw-r--r-- | bindings/python/docs/source/quickstart.rst | 19 |
2 files changed, 20 insertions, 13 deletions
diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst index fc3179b4..dec9697f 100644 --- a/bindings/python/docs/source/index.rst +++ b/bindings/python/docs/source/index.rst @@ -15,25 +15,13 @@ 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 status_and_errors notmuch diff --git a/bindings/python/docs/source/quickstart.rst b/bindings/python/docs/source/quickstart.rst new file mode 100644 index 00000000..609f42e1 --- /dev/null +++ b/bindings/python/docs/source/quickstart.rst @@ -0,0 +1,19 @@ +Quickstart and examples +======================= + +.. todo:: write a nice introduction +.. todo:: improve the examples + +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) |