mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-25 12:28:09 +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>
This commit is contained in:
Justus Winter
parent
594dbb6243
commit
d50171d1cc
9 changed files with 257 additions and 251 deletions
48
bindings/python/docs/source/database.rst
Normal file
48
bindings/python/docs/source/database.rst
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
:class:`Database` -- The underlying notmuch database
|
||||||
|
====================================================
|
||||||
|
|
||||||
|
.. currentmodule:: notmuch
|
||||||
|
|
||||||
|
.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
|
||||||
|
|
||||||
|
.. automethod:: create
|
||||||
|
|
||||||
|
.. automethod:: open(path, status=MODE.READ_ONLY)
|
||||||
|
|
||||||
|
.. automethod:: get_path
|
||||||
|
|
||||||
|
.. automethod:: get_version
|
||||||
|
|
||||||
|
.. automethod:: needs_upgrade
|
||||||
|
|
||||||
|
.. automethod:: upgrade
|
||||||
|
|
||||||
|
.. automethod:: begin_atomic
|
||||||
|
|
||||||
|
.. automethod:: end_atomic
|
||||||
|
|
||||||
|
.. automethod:: get_directory
|
||||||
|
|
||||||
|
.. automethod:: add_message
|
||||||
|
|
||||||
|
.. automethod:: remove_message
|
||||||
|
|
||||||
|
.. automethod:: find_message
|
||||||
|
|
||||||
|
.. automethod:: find_message_by_filename
|
||||||
|
|
||||||
|
.. automethod:: get_all_tags
|
||||||
|
|
||||||
|
.. automethod:: create_query
|
||||||
|
|
||||||
|
.. attribute:: Database.MODE
|
||||||
|
|
||||||
|
Defines constants that are used as the mode in which to open a database.
|
||||||
|
|
||||||
|
MODE.READ_ONLY
|
||||||
|
Open the database in read-only mode
|
||||||
|
|
||||||
|
MODE.READ_WRITE
|
||||||
|
Open the database in read-write mode
|
||||||
|
|
||||||
|
.. autoattribute:: db_p
|
||||||
30
bindings/python/docs/source/filesystem.rst
Normal file
30
bindings/python/docs/source/filesystem.rst
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
Files and directories
|
||||||
|
=====================
|
||||||
|
|
||||||
|
.. currentmodule:: notmuch
|
||||||
|
|
||||||
|
:class:`Filenames` -- An iterator over filenames
|
||||||
|
------------------------------------------------
|
||||||
|
|
||||||
|
.. autoclass:: Filenames
|
||||||
|
|
||||||
|
.. automethod:: Filenames.__len__
|
||||||
|
|
||||||
|
.. automethod:: Filenames.as_generator
|
||||||
|
|
||||||
|
:class:`Directoy` -- A directory entry in the database
|
||||||
|
------------------------------------------------------
|
||||||
|
|
||||||
|
.. autoclass:: Directory
|
||||||
|
|
||||||
|
.. automethod:: Directory.get_child_files
|
||||||
|
|
||||||
|
.. automethod:: Directory.get_child_directories
|
||||||
|
|
||||||
|
.. automethod:: Directory.get_mtime
|
||||||
|
|
||||||
|
.. automethod:: Directory.set_mtime
|
||||||
|
|
||||||
|
.. autoattribute:: Directory.mtime
|
||||||
|
|
||||||
|
.. autoattribute:: Directory.path
|
||||||
|
|
@ -1,272 +1,37 @@
|
||||||
.. notmuch documentation master file, created by
|
Welcome to :mod:`notmuch`'s documentation
|
||||||
sphinx-quickstart on Tue Feb 2 10:00:47 2010.
|
=========================================
|
||||||
|
|
||||||
.. currentmodule:: notmuch
|
.. currentmodule:: notmuch
|
||||||
|
|
||||||
Welcome to :mod:`notmuch`'s documentation
|
The :mod:`notmuch` module provides an interface to the `notmuch
|
||||||
===========================================
|
<http://notmuchmail.org>`_ functionality, directly interfacing to a
|
||||||
|
shared notmuch library. Within :mod:`notmuch`, the classes
|
||||||
The :mod:`notmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality, directly interfacing to a shared notmuch library.
|
:class:`Database`, :class:`Query` provide most of the core
|
||||||
Within :mod:`notmuch`, the classes :class:`Database`, :class:`Query` provide most of the core functionality, returning :class:`Threads`, :class:`Messages` and :class:`Tags`.
|
functionality, returning :class:`Threads`, :class:`Messages` and
|
||||||
|
:class:`Tags`.
|
||||||
|
|
||||||
.. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
|
.. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
|
||||||
|
|
||||||
:License: This module is covered under the GNU GPL v3 (or later).
|
:License: This module is covered under the GNU GPL v3 (or later).
|
||||||
|
|
||||||
This page contains the main API overview of notmuch |release|.
|
|
||||||
|
|
||||||
|
|
||||||
More information on specific topics can be found on the following pages:
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
quickstart
|
quickstart
|
||||||
notes
|
notes
|
||||||
status_and_errors
|
status_and_errors
|
||||||
|
database
|
||||||
|
query
|
||||||
|
messages
|
||||||
|
message
|
||||||
|
tags
|
||||||
|
threads
|
||||||
|
thread
|
||||||
|
filesystem
|
||||||
notmuch
|
notmuch
|
||||||
|
|
||||||
:class:`Database` -- The underlying notmuch database
|
|
||||||
---------------------------------------------------------------------
|
|
||||||
|
|
||||||
.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
|
|
||||||
|
|
||||||
.. automethod:: create
|
|
||||||
|
|
||||||
.. automethod:: open(path, status=MODE.READ_ONLY)
|
|
||||||
|
|
||||||
.. automethod:: get_path
|
|
||||||
|
|
||||||
.. automethod:: get_version
|
|
||||||
|
|
||||||
.. automethod:: needs_upgrade
|
|
||||||
|
|
||||||
.. automethod:: upgrade
|
|
||||||
|
|
||||||
.. automethod:: begin_atomic
|
|
||||||
|
|
||||||
.. automethod:: end_atomic
|
|
||||||
|
|
||||||
.. automethod:: get_directory
|
|
||||||
|
|
||||||
.. automethod:: add_message
|
|
||||||
|
|
||||||
.. automethod:: remove_message
|
|
||||||
|
|
||||||
.. automethod:: find_message
|
|
||||||
|
|
||||||
.. automethod:: find_message_by_filename
|
|
||||||
|
|
||||||
.. automethod:: get_all_tags
|
|
||||||
|
|
||||||
.. automethod:: create_query
|
|
||||||
|
|
||||||
.. attribute:: Database.MODE
|
|
||||||
|
|
||||||
Defines constants that are used as the mode in which to open a database.
|
|
||||||
|
|
||||||
MODE.READ_ONLY
|
|
||||||
Open the database in read-only mode
|
|
||||||
|
|
||||||
MODE.READ_WRITE
|
|
||||||
Open the database in read-write mode
|
|
||||||
|
|
||||||
.. autoattribute:: db_p
|
|
||||||
|
|
||||||
|
|
||||||
:class:`Query` -- A search query
|
|
||||||
-------------------------------------------------
|
|
||||||
|
|
||||||
.. autoclass:: Query
|
|
||||||
|
|
||||||
.. automethod:: create
|
|
||||||
|
|
||||||
.. attribute:: Query.SORT
|
|
||||||
|
|
||||||
Defines constants that are used as the mode in which to open a database.
|
|
||||||
|
|
||||||
SORT.OLDEST_FIRST
|
|
||||||
Sort by message date, oldest first.
|
|
||||||
|
|
||||||
SORT.NEWEST_FIRST
|
|
||||||
Sort by message date, newest first.
|
|
||||||
|
|
||||||
SORT.MESSAGE_ID
|
|
||||||
Sort by email message ID.
|
|
||||||
|
|
||||||
SORT.UNSORTED
|
|
||||||
Do not apply a special sort order (returns results in document id
|
|
||||||
order).
|
|
||||||
|
|
||||||
.. automethod:: set_sort
|
|
||||||
|
|
||||||
.. attribute:: sort
|
|
||||||
|
|
||||||
Instance attribute :attr:`sort` contains the sort order (see
|
|
||||||
:attr:`Query.SORT`) if explicitely specified via
|
|
||||||
:meth:`set_sort`. By default it is set to `None`.
|
|
||||||
|
|
||||||
.. automethod:: search_threads
|
|
||||||
|
|
||||||
.. automethod:: search_messages
|
|
||||||
|
|
||||||
.. automethod:: count_messages
|
|
||||||
|
|
||||||
.. automethod:: count_threads
|
|
||||||
|
|
||||||
|
|
||||||
:class:`Messages` -- A bunch of messages
|
|
||||||
----------------------------------------
|
|
||||||
|
|
||||||
.. autoclass:: Messages
|
|
||||||
|
|
||||||
.. automethod:: collect_tags
|
|
||||||
|
|
||||||
.. method:: __len__()
|
|
||||||
|
|
||||||
.. warning::
|
|
||||||
|
|
||||||
:meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke
|
|
||||||
list(Messages()). Use the :meth:`Query.count_messages` function or use `len(list(msgs))`.
|
|
||||||
|
|
||||||
:class:`Message` -- A single message
|
|
||||||
----------------------------------------
|
|
||||||
|
|
||||||
.. autoclass:: Message
|
|
||||||
|
|
||||||
.. automethod:: get_message_id
|
|
||||||
|
|
||||||
.. automethod:: get_thread_id
|
|
||||||
|
|
||||||
.. automethod:: get_replies
|
|
||||||
|
|
||||||
.. automethod:: get_filename
|
|
||||||
|
|
||||||
.. automethod:: get_filenames
|
|
||||||
|
|
||||||
.. attribute:: FLAG
|
|
||||||
|
|
||||||
FLAG.MATCH
|
|
||||||
This flag is automatically set by a
|
|
||||||
Query.search_threads on those messages that match the
|
|
||||||
query. This allows us to distinguish matches from the rest
|
|
||||||
of the messages in that thread.
|
|
||||||
|
|
||||||
.. automethod:: get_flag
|
|
||||||
|
|
||||||
.. automethod:: set_flag
|
|
||||||
|
|
||||||
.. automethod:: get_date
|
|
||||||
|
|
||||||
.. automethod:: get_header
|
|
||||||
|
|
||||||
.. automethod:: get_tags
|
|
||||||
|
|
||||||
.. automethod:: maildir_flags_to_tags
|
|
||||||
|
|
||||||
.. automethod:: tags_to_maildir_flags
|
|
||||||
|
|
||||||
.. automethod:: remove_tag
|
|
||||||
|
|
||||||
.. automethod:: add_tag
|
|
||||||
|
|
||||||
.. automethod:: remove_all_tags
|
|
||||||
|
|
||||||
.. automethod:: freeze
|
|
||||||
|
|
||||||
.. automethod:: thaw
|
|
||||||
|
|
||||||
.. automethod:: format_message_as_json
|
|
||||||
|
|
||||||
.. automethod:: format_message_as_text
|
|
||||||
|
|
||||||
.. automethod:: __str__
|
|
||||||
|
|
||||||
|
|
||||||
:class:`Tags` -- Notmuch tags
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. autoclass:: Tags
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. method:: __len__
|
|
||||||
|
|
||||||
.. warning::
|
|
||||||
|
|
||||||
:meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke
|
|
||||||
list(Tags()). Use :meth:`len(list(msgs))` instead if you need to know the number of
|
|
||||||
tags.
|
|
||||||
|
|
||||||
.. automethod:: __str__
|
|
||||||
|
|
||||||
|
|
||||||
:class:`Threads` -- Threads iterator
|
|
||||||
-----------------------------------------------------
|
|
||||||
|
|
||||||
.. autoclass:: Threads
|
|
||||||
|
|
||||||
.. automethod:: __len__
|
|
||||||
|
|
||||||
.. automethod:: __str__
|
|
||||||
|
|
||||||
:class:`Thread` -- A single thread
|
|
||||||
------------------------------------
|
|
||||||
|
|
||||||
.. autoclass:: Thread
|
|
||||||
|
|
||||||
.. automethod:: get_thread_id
|
|
||||||
|
|
||||||
.. automethod:: get_total_messages
|
|
||||||
|
|
||||||
.. automethod:: get_toplevel_messages
|
|
||||||
|
|
||||||
.. automethod:: get_matched_messages
|
|
||||||
|
|
||||||
.. automethod:: get_authors
|
|
||||||
|
|
||||||
.. automethod:: get_subject
|
|
||||||
|
|
||||||
.. automethod:: get_oldest_date
|
|
||||||
|
|
||||||
.. automethod:: get_newest_date
|
|
||||||
|
|
||||||
.. automethod:: get_tags
|
|
||||||
|
|
||||||
.. automethod:: __str__
|
|
||||||
|
|
||||||
|
|
||||||
:class:`Filenames` -- An iterator over filenames
|
|
||||||
------------------------------------------------
|
|
||||||
|
|
||||||
.. autoclass:: Filenames
|
|
||||||
|
|
||||||
.. automethod:: Filenames.__len__
|
|
||||||
|
|
||||||
.. automethod:: Filenames.as_generator
|
|
||||||
|
|
||||||
:class:`Directoy` -- A directory entry in the database
|
|
||||||
------------------------------------------------------------------------
|
|
||||||
|
|
||||||
.. autoclass:: Directory
|
|
||||||
|
|
||||||
.. automethod:: Directory.get_child_files
|
|
||||||
|
|
||||||
.. automethod:: Directory.get_child_directories
|
|
||||||
|
|
||||||
.. automethod:: Directory.get_mtime
|
|
||||||
|
|
||||||
.. automethod:: Directory.set_mtime
|
|
||||||
|
|
||||||
.. autoattribute:: Directory.mtime
|
|
||||||
|
|
||||||
.. autoattribute:: Directory.path
|
|
||||||
|
|
||||||
|
|
||||||
The `next page <status_and_errors.html>`_ contains information on possible Status and Error values.
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
||||||
|
|
|
||||||
54
bindings/python/docs/source/message.rst
Normal file
54
bindings/python/docs/source/message.rst
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
:class:`Message` -- A single message
|
||||||
|
====================================
|
||||||
|
|
||||||
|
.. currentmodule:: notmuch
|
||||||
|
|
||||||
|
.. autoclass:: Message
|
||||||
|
|
||||||
|
.. automethod:: get_message_id
|
||||||
|
|
||||||
|
.. automethod:: get_thread_id
|
||||||
|
|
||||||
|
.. automethod:: get_replies
|
||||||
|
|
||||||
|
.. automethod:: get_filename
|
||||||
|
|
||||||
|
.. automethod:: get_filenames
|
||||||
|
|
||||||
|
.. attribute:: FLAG
|
||||||
|
|
||||||
|
FLAG.MATCH
|
||||||
|
This flag is automatically set by a
|
||||||
|
Query.search_threads on those messages that match the
|
||||||
|
query. This allows us to distinguish matches from the rest
|
||||||
|
of the messages in that thread.
|
||||||
|
|
||||||
|
.. automethod:: get_flag
|
||||||
|
|
||||||
|
.. automethod:: set_flag
|
||||||
|
|
||||||
|
.. automethod:: get_date
|
||||||
|
|
||||||
|
.. automethod:: get_header
|
||||||
|
|
||||||
|
.. automethod:: get_tags
|
||||||
|
|
||||||
|
.. automethod:: maildir_flags_to_tags
|
||||||
|
|
||||||
|
.. automethod:: tags_to_maildir_flags
|
||||||
|
|
||||||
|
.. automethod:: remove_tag
|
||||||
|
|
||||||
|
.. automethod:: add_tag
|
||||||
|
|
||||||
|
.. automethod:: remove_all_tags
|
||||||
|
|
||||||
|
.. automethod:: freeze
|
||||||
|
|
||||||
|
.. automethod:: thaw
|
||||||
|
|
||||||
|
.. automethod:: format_message_as_json
|
||||||
|
|
||||||
|
.. automethod:: format_message_as_text
|
||||||
|
|
||||||
|
.. automethod:: __str__
|
||||||
15
bindings/python/docs/source/messages.rst
Normal file
15
bindings/python/docs/source/messages.rst
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
:class:`Messages` -- A bunch of messages
|
||||||
|
========================================
|
||||||
|
|
||||||
|
.. currentmodule:: notmuch
|
||||||
|
|
||||||
|
.. autoclass:: Messages
|
||||||
|
|
||||||
|
.. automethod:: collect_tags
|
||||||
|
|
||||||
|
.. method:: __len__()
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
:meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke
|
||||||
|
list(Messages()). Use the :meth:`Query.count_messages` function or use `len(list(msgs))`.
|
||||||
41
bindings/python/docs/source/query.rst
Normal file
41
bindings/python/docs/source/query.rst
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
:class:`Query` -- A search query
|
||||||
|
================================
|
||||||
|
|
||||||
|
.. currentmodule:: notmuch
|
||||||
|
|
||||||
|
.. autoclass:: Query
|
||||||
|
|
||||||
|
.. automethod:: create
|
||||||
|
|
||||||
|
.. attribute:: Query.SORT
|
||||||
|
|
||||||
|
Defines constants that are used as the mode in which to open a database.
|
||||||
|
|
||||||
|
SORT.OLDEST_FIRST
|
||||||
|
Sort by message date, oldest first.
|
||||||
|
|
||||||
|
SORT.NEWEST_FIRST
|
||||||
|
Sort by message date, newest first.
|
||||||
|
|
||||||
|
SORT.MESSAGE_ID
|
||||||
|
Sort by email message ID.
|
||||||
|
|
||||||
|
SORT.UNSORTED
|
||||||
|
Do not apply a special sort order (returns results in document id
|
||||||
|
order).
|
||||||
|
|
||||||
|
.. automethod:: set_sort
|
||||||
|
|
||||||
|
.. attribute:: sort
|
||||||
|
|
||||||
|
Instance attribute :attr:`sort` contains the sort order (see
|
||||||
|
:attr:`Query.SORT`) if explicitely specified via
|
||||||
|
:meth:`set_sort`. By default it is set to `None`.
|
||||||
|
|
||||||
|
.. automethod:: search_threads
|
||||||
|
|
||||||
|
.. automethod:: search_messages
|
||||||
|
|
||||||
|
.. automethod:: count_messages
|
||||||
|
|
||||||
|
.. automethod:: count_threads
|
||||||
17
bindings/python/docs/source/tags.rst
Normal file
17
bindings/python/docs/source/tags.rst
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
:class:`Tags` -- Notmuch tags
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
.. currentmodule:: notmuch
|
||||||
|
|
||||||
|
.. autoclass:: Tags
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. method:: __len__
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
:meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke
|
||||||
|
list(Tags()). Use :meth:`len(list(msgs))` instead if you need to know the number of
|
||||||
|
tags.
|
||||||
|
|
||||||
|
.. automethod:: __str__
|
||||||
26
bindings/python/docs/source/thread.rst
Normal file
26
bindings/python/docs/source/thread.rst
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
:class:`Thread` -- A single thread
|
||||||
|
==================================
|
||||||
|
|
||||||
|
.. currentmodule:: notmuch
|
||||||
|
|
||||||
|
.. autoclass:: Thread
|
||||||
|
|
||||||
|
.. automethod:: get_thread_id
|
||||||
|
|
||||||
|
.. automethod:: get_total_messages
|
||||||
|
|
||||||
|
.. automethod:: get_toplevel_messages
|
||||||
|
|
||||||
|
.. automethod:: get_matched_messages
|
||||||
|
|
||||||
|
.. automethod:: get_authors
|
||||||
|
|
||||||
|
.. automethod:: get_subject
|
||||||
|
|
||||||
|
.. automethod:: get_oldest_date
|
||||||
|
|
||||||
|
.. automethod:: get_newest_date
|
||||||
|
|
||||||
|
.. automethod:: get_tags
|
||||||
|
|
||||||
|
.. automethod:: __str__
|
||||||
10
bindings/python/docs/source/threads.rst
Normal file
10
bindings/python/docs/source/threads.rst
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
:class:`Threads` -- Threads iterator
|
||||||
|
====================================
|
||||||
|
|
||||||
|
.. currentmodule:: notmuch
|
||||||
|
|
||||||
|
.. autoclass:: Threads
|
||||||
|
|
||||||
|
.. automethod:: __len__
|
||||||
|
|
||||||
|
.. automethod:: __str__
|
||||||
Loading…
Reference in a new issue