debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-23 11:28:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/bindings/python/docs/source/index.rst

37 lines
807 B
ReStructuredText
Raw Normal View History

python: split the documentation 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-24 01:34:15 +01:00
Welcome to :mod:`notmuch`'s documentation
=========================================
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
python: adapt docs to the notmuch module renaming
2010-04-19 21:25:05 +02:00
.. currentmodule:: 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
python: split the documentation 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-24 01:34:15 +01:00
The :mod:`notmuch` module provides an interface to the `notmuch
Use https instead of http where possible 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-06-02 18:26:14 +02:00
<https://notmuchmail.org>`_ functionality, directly interfacing to a
python: split the documentation 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-24 01:34:15 +01:00
shared notmuch library. Within :mod:`notmuch`, the classes
:class:`Database`, :class:`Query` provide most of the core
functionality, returning :class:`Threads`, :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
.. toctree::
:maxdepth: 1
python: move the usage example to quickstart.rst Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-24 01:18:54 +01:00
quickstart
python: move the notmuch module section to notes.rst Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-02-24 01:30:04 +01:00
notes
python: Improve API documentation Various API doc cleanups and improvements. No code change. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2011-06-16 15:41:48 +02:00
status_and_errors
python: split the documentation 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-24 01:34:15 +01:00
database
query
messages
message
tags
threads
thread
filesystem
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
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`
Reference in a new issue Copy permalink