aboutsummaryrefslogtreecommitdiff
path: root/bindings/python/docs/source/index.rst
AgeCommit message (Collapse)Author
2025-02-22python: move legacy python bindings to contrib.David Bremner
This forces us to verify the build and test suite completes without the legacy python bindings. As of this commit the legacy python bindings are unsupported by notmuch. They are provided in contrib/ for now, but will most likely eventually be removed from there as well. We recommend that downstream/distro packagers phase out their packages for the legacy python bindings.
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.
2012-05-17python: remove the "notmuch binary" section from the docsJustus Winter
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-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-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>
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-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.