summaryrefslogtreecommitdiff
path: root/bindings/python/docs
AgeCommit message (Collapse)Author
2017-12-24python: Fix method name in docsl-m-h@web.de
Fix a method rename in the docs that was overlooked in 3444c731d27fd42bbbdaae00af6ca48b4525b03b.
2017-12-19python: add bindings to access configl-m-h@web.de
The C functions notmuch_database_get_config, notmuch_database_get_config_list and notmuch_database_set_config are part of the official C bindings. So there should also be some python bindings for them. Also they are the only way to access the named queries introduced in b9bf3f44. The interface of the python functions is designed to be close to the C functions.
2017-08-23database: add n_d_index_file (deprecates n_d_add_message)Daniel Kahn Gillmor
We need a way to pass parameters to the indexing functionality on the first index, not just on reindexing. The obvious place is in notmuch_database_add_message. But since modifying the argument list would break both API and ABI, we needed a new name. I considered notmuch_database_add_message_with_params(), but the functionality we're talking about doesn't always add a message. It tries to index a specific file, possibly adding a message, but possibly doing other things, like adding terms to an existing message, or failing to deal with message objects entirely (e.g. because the file didn't contain a message). So i chose the function name notmuch_database_index_file. I confess i'm a little concerned about confusing future notmuch developers with the new name, since we already have a private _notmuch_message_index_file function, and the two do rather different things. But i think the added clarity for people linking against the future libnotmuch and the capacity for using index parameters makes this a worthwhile tradeoff. (that said, if anyone has another name that they strongly prefer, i'd be happy to go with it) This changeset also adjusts the tests so that we test whether the new, preferred function returns bad values (since the deprecated function just calls the new one). We can keep the deprecated n_d_add_message function around as long as we like, but at the next place where we're forced to break API or ABI we can probably choose to drop the name relatively safely. NOTE: there is probably more cleanup to do in the ruby and go bindings to complete the deprecation directly. I don't know those languages well enough to attempt a fix; i don't know how to test them; and i don't know the culture around those languages about API additions or deprecations.
2017-07-18Fix orthographyDaniel Kahn Gillmor
2016-06-05Use https instead of http where possibleDaniel Kahn Gillmor
Many of the external links found in the notmuch source can be resolved using https instead of http. This changeset addresses as many as i could find, without touching the e-mail corpus or expected outputs found in tests.
2016-01-08python: Remove {Filenames,Threads}.__len__Justus Winter
Remove the __len__ functions, as they exhaust the iterator, breaking 'list(x)'. This is a follow-up to 8866a89e. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2016-01-08python: add new errorsJustus Winter
Add support for the new notmuch status codes UNSUPPORTED_OPERATION, UPGRADE_REQUIRED, and PATH_ERROR. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2014-09-23python: Add binding for notmuch_query_add_tag_excludeThibaut Horel
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.
2014-05-28Unset html_static_path in Python bindings docsAmadeusz Żołnowski
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.
2012-12-21python: remove Database.db_pJustus Winter
The function has been marked as deprecated in 0.14 and is now removed. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-05-17python: remove the "notmuch binary" section from the docsJustus Winter
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-05-16python: remove format_message_as_{json,text} from the sphinx docsJustus Winter
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-04-30python: document the Database.close functionJustus Winter
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>
2012-04-30python: fix the documentationJustus Winter
Remove the reference to Filenames.as_generator in the sphinx documentation. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-24python: split the documentationJustus Winter
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>
2012-02-24python: move the notmuch module section to notes.rstJustus Winter
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-24python: move the usage example to quickstart.rstJustus Winter
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-24python: strip module prefix in the sphinx documentationJustus Winter
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>
2012-02-23python: mention the exception class refactoring in the docsJustus Winter
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-22python: refactor the python bindingsJustus Winter
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-20python: fix the projects name and update years of the copyright notice in the sphinx docsJustus Winter
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-18python: remove trailing whitespace within the documentation source filesJustus Winter
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-18python: wrap notmuch_query_count_threads as Query.count_threadsJustus Winter
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-10python: mock out the ctypes libraryJustus Winter
This allows rtfd.org to build the documentation without libnotmuch. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-10python: Add a Mock class to the sphinx config that can be used to mock modulesJustus Winter
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2011-12-06fix sphinx compile-time warningsPatrick Totzke
no changes to the code, only makes compiling the docs smoother as some rsT syntax errors were fixed
2011-10-05python: clean up docstrings and API documentationSebastian Spaeth
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2011-10-05python: Add the new exception types in the API documentationSebastian Spaeth
as they should be documented... Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2011-09-29python: Add new functions in API documentationSebastian Spaeth
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-29python: Improve code documentationSebastian Spaeth
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>
2011-06-16python: Improve API documentationSebastian Spaeth
Various API doc cleanups and improvements. No code change. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2011-06-15python: Remove Messages().__len__Sebastian Spaeth
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-02bindings/python: Include the new get_filenames in the API docsSebastian Spaeth
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>
2010-04-23python: Add UNSORTED as Query.SORT optionSebastian Spaeth
Keep up to date with the libnotmuch.so API. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2010-04-21Move everything down into a bindings/python directory.Carl Worth
In preparation for merging the python bindings into the notmuch repository.
generated by cgit v1.2.3 (git 2.51.0) at 2026-06-23 20:49:16 +0000