debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-25 10:54:52 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/docs/source/index.rst

85 lines
2.3 KiB
ReStructuredText
Raw Normal View History

update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
.. cnotmuch documentation master file, created by
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
sphinx-quickstart on Tue Feb 2 10:00:47 2010.
update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
.. currentmodule:: cnotmuch.notmuch
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
Welcome to notmuch's documentation!
===================================
update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
The :mod:`cnotmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality, directly interfacing to a shared notmuch library.
The classes :class:`Database`, :class:`Query` provide most of the core functionality, returning :class:`Messages` and :class:`Tags`.
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
.. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
:License: This module is covered under the GNU GPL v3 (or later).
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
This page contains the main API overview. More information on specific topics can be found on the following pages: (none here yet)
Notmuch can be imported as:
from cnotmuch import notmuch
or:
from cnotmuch.notmuch import Query,Database
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
.. toctree::
:maxdepth: 1
:mod:`notmuch` -- The Notmuch interface
=============================================
update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
Document from cnotmuch.globals import nmlib,STATUS,NotmuchError
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
:class:`Database` -- The underlying notmuch database
-----------------------------------------------------
.. autoclass:: Database
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
:members:
update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
:class:`Query` -- Represents a notmuch Query
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
-----------------------------------------------
update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
.. autoclass:: Query
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
:members:
.. note:: A Thread is what a call to notmuch.show() will return, containing a bunch of :class:`Message`\ s.
update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
:class:`Messages` -- A bunch of messages
----------------------------------------
.. autoclass:: Messages
:members:
:class:`Message` -- A single message
----------------------------------------
.. autoclass:: Message
:members:
:class:`Tags` -- A bunch of notmuch tags
----------------------------------------
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
update documentation so it makes sense --HG-- extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
2010-03-16 20:54:43 +01:00
.. autoclass:: Tags
add sphinx docs stubs (they don't make sense yet) --HG-- extra : transplant_source : %F3A%2C%D95%02%BF%1B%A1%D7%17%07%EDqh%23l8%93%20
2010-03-16 20:36:04 +01:00
:members:
.. data: '__notmuchcmd__'
This is the actual binary that will be executed in order to run a notmuch command. This is set to *notmuch* and should usually not be changed.
:exc:`NotmuchError` -- A Notmuch execution error
------------------------------------------------
.. autoexception:: NotmuchError
:members:
This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`
Reference in a new issue Copy permalink