summaryrefslogtreecommitdiff
path: root/bindings/python/docs/source
AgeCommit message (Collapse)Author
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 22:51:47 +0000