aboutsummaryrefslogtreecommitdiffhomepage
path: root/bindings/python/docs
Commit message (Collapse)AuthorAge
* python: Add binding for notmuch_query_add_tag_excludeGravatar Thibaut Horel2014-09-23
| | | | | Implemented as the method `exclude_tag` of the class `Query`. This method takes one argument, a string containing the name of the tag to exclude.
* Unset html_static_path in Python bindings docsGravatar Amadeusz Żołnowski2014-05-28
| | | | | | html_static_path is a kind of source directory and it was set to destination directory (../html) which caused infinite recursion with Sphinx 1.2 and above.
* python: remove Database.db_pGravatar Justus Winter2012-12-21
| | | | | | The function has been marked as deprecated in 0.14 and is now removed. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: remove the "notmuch binary" section from the docsGravatar Justus Winter2012-05-17
| | | | Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: remove format_message_as_{json,text} from the sphinx docsGravatar Justus Winter2012-05-16
| | | | Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: document the Database.close functionGravatar Justus Winter2012-04-30
| | | | | | | | Put a prominent warning into the docstring of Database.close, make the function show up in the sphinx doc and refer to the warning in the paragraph mentioning the context manager protocol. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: fix the documentationGravatar Justus Winter2012-04-30
| | | | | | | Remove the reference to Filenames.as_generator in the sphinx documentation. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: split the documentationGravatar Justus Winter2012-02-24
| | | | | | | Move each classes documentation into its own file and thus into its own page in the generated documentation. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: move the notmuch module section to notes.rstGravatar Justus Winter2012-02-24
| | | | Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: move the usage example to quickstart.rstGravatar Justus Winter2012-02-24
| | | | Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: strip module prefix in the sphinx documentationGravatar Justus Winter2012-02-24
| | | | | | | Remove the notmuch prefix from classes in the documentation. This change makes the table of contents look much nicer. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: mention the exception class refactoring in the docsGravatar Justus Winter2012-02-23
| | | | Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: refactor the python bindingsGravatar Justus Winter2012-02-22
| | | | | | | | 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>
* python: fix the projects name and update years of the copyright notice in ↵Gravatar Justus Winter2012-02-20
| | | | | | the sphinx docs Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: remove trailing whitespace within the documentation source filesGravatar Justus Winter2012-02-18
| | | | Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: wrap notmuch_query_count_threads as Query.count_threadsGravatar Justus Winter2012-02-18
| | | | Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: mock out the ctypes libraryGravatar Justus Winter2012-02-10
| | | | | | This allows rtfd.org to build the documentation without libnotmuch. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* python: Add a Mock class to the sphinx config that can be used to mock modulesGravatar Justus Winter2012-02-10
| | | | Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
* fix sphinx compile-time warningsGravatar Patrick Totzke2011-12-06
| | | | | no changes to the code, only makes compiling the docs smoother as some rsT syntax errors were fixed
* python: clean up docstrings and API documentationGravatar Sebastian Spaeth2011-10-05
| | | | Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
* python: Add the new exception types in the API documentationGravatar Sebastian Spaeth2011-10-05
| | | | | | as they should be documented... Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
* python: Add new functions in API documentationGravatar Sebastian Spaeth2011-09-29
| | | | | | | Add documentation for the three new functions and add in which version they have been added. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
* python: Improve code documentationGravatar Sebastian Spaeth2011-09-29
| | | | | | | | 1) Fix added .gitignore from commit dc8a1745 to work on the docs folder 2) Improve in-code developer documentation to produce better sphinx-generated documentation. No code changes. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
* python: Improve API documentationGravatar Sebastian Spaeth2011-06-16
| | | | | | Various API doc cleanups and improvements. No code change. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
* python: Remove Messages().__len__Gravatar Sebastian Spaeth2011-06-15
| | | | | | | | | | | 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>
* bindings/python: Include the new get_filenames in the API docsGravatar Sebastian Spaeth2011-06-02
| | | | | | | 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>
* python: Add UNSORTED as Query.SORT optionGravatar Sebastian Spaeth2010-04-23
| | | | | | Keep up to date with the libnotmuch.so API. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
* Move everything down into a bindings/python directory.Gravatar Carl Worth2010-04-21
In preparation for merging the python bindings into the notmuch repository.
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-09 23:08:45 +0000