Justus Winter
90fb4e8334
python: mention the exception class refactoring in the docs
...
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-23 00:14:59 +01:00
Justus Winter
ba95980cf1
python: refactor the python bindings
...
Move the Directory class into its own file, merge the two Filenames
classes into one, deprecate Filenames.as_iterator, update the
documentation accordingly.
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-22 22:06:45 +01:00
Justus Winter
4bb9f59ff6
python: fix the projects name and update years of the copyright notice in the sphinx docs
...
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-20 21:48:35 +01:00
Justus Winter
ab2f9fd828
python: remove trailing whitespace within the documentation source files
...
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-18 01:41:23 +01:00
Justus Winter
ff8f864245
python: wrap notmuch_query_count_threads as Query.count_threads
...
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-18 01:39:39 +01:00
Justus Winter
ae376c774e
python: mock out the ctypes library
...
This allows rtfd.org to build the documentation without libnotmuch.
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-10 18:55:33 +01:00
Justus Winter
8c5be7d12d
python: Add a Mock class to the sphinx config that can be used to mock modules
...
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-10 18:54:49 +01:00
Patrick Totzke
12ebf87947
fix sphinx compile-time warnings
...
no changes to the code, only makes compiling the docs smoother
as some rsT syntax errors were fixed
2011-12-06 12:23:50 +01:00
Sebastian Spaeth
42f184c236
python: clean up docstrings and API documentation
...
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2011-10-05 17:54:09 +02:00
Sebastian Spaeth
2b43a65c1c
python: Add the new exception types in the API documentation
...
as they should be documented...
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2011-10-05 16:58:13 +02:00
Sebastian Spaeth
f63d605835
python: Add new functions in API documentation
...
Add documentation for the three new functions and add in which version
they have been added.
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2011-09-29 11:00:43 +02:00
Sebastian Spaeth
eb4cd33e6b
python: Improve code documentation
...
1) Fix added .gitignore from commit dc8a1745
2011-09-29 10:47:28 +02:00
Sebastian Spaeth
0817f0e168
python: Improve API documentation
...
Various API doc cleanups and improvements. No code change.
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2011-06-16 15:41:48 +02:00
Sebastian Spaeth
8866a89e3c
python: Remove Messages().__len__
...
Messages.__len__() exhausted the iterator and list() inherently calls
len(), so we could not invoke list(msgs) without getting errors. Fix
this by implementing __nonzero__ but removing __len__ on Messages.
Use Query.count_messages() or len(list(msgs)) if you need to know the
number.
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2011-06-15 14:25:33 +02:00
Sebastian Spaeth
4d406d9c25
bindings/python: Include the new get_filenames in the API docs
...
They had accidentally been left out, so we should also include the
function docs for get_messages in the API docs.
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2011-06-02 09:20:56 +02:00
Sebastian Spaeth
af8664689a
python: Add UNSORTED as Query.SORT option
...
Keep up to date with the libnotmuch.so API.
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2010-04-23 13:40:38 +02:00
Carl Worth
3b558de781
Move everything down into a bindings/python directory.
...
In preparation for merging the python bindings into the notmuch
repository.
2010-04-21 17:29:34 -07:00
