From 0c00693362b8462ea7ce10d0280679a6e5348c13 Mon Sep 17 00:00:00 2001 From: Patrick Totzke Date: Sat, 23 Jun 2018 17:02:47 +0100 Subject: update docs --- docs/source/api/commands.rst | 6 ++++++ docs/source/api/interface.rst | 21 +++++++++++---------- docs/source/configuration/key_bindings.rst | 5 +++-- docs/source/usage/cli_commands.rst | 3 +++ docs/source/usage/commands.rst | 21 ++++++++++++--------- 5 files changed, 35 insertions(+), 21 deletions(-) (limited to 'docs') diff --git a/docs/source/api/commands.rst b/docs/source/api/commands.rst index cae10a03..13520b13 100644 --- a/docs/source/api/commands.rst +++ b/docs/source/api/commands.rst @@ -73,6 +73,12 @@ Taglist .. automodule:: alot.commands.taglist :members: +Namedqueries +------------ + +.. automodule:: alot.commands.namedqueries + :members: + Thread -------- diff --git a/docs/source/api/interface.rst b/docs/source/api/interface.rst index 39b9cd3c..7babae93 100644 --- a/docs/source/api/interface.rst +++ b/docs/source/api/interface.rst @@ -53,18 +53,19 @@ Different modes are defined by subclasses of the following base class. Available modes are: -========== ======================================== - Mode Buffer Subclass -========== ======================================== -search :class:`~alot.buffers.SearchBuffer` -thread :class:`~alot.buffers.ThreadBuffer` -bufferlist :class:`~alot.buffers.BufferlistBuffer` -taglist :class:`~alot.buffers.TagListBuffer` -envelope :class:`~alot.buffers.EnvelopeBuffer` -========== ======================================== +============ ======================================== + Mode Buffer Subclass +============ ======================================== +search :class:`~alot.buffers.SearchBuffer` +thread :class:`~alot.buffers.ThreadBuffer` +bufferlist :class:`~alot.buffers.BufferlistBuffer` +taglist :class:`~alot.buffers.TagListBuffer` +namedqueries :class:`~alot.buffers.NamedQueriesBuffer` +envelope :class:`~alot.buffers.EnvelopeBuffer` +============ ======================================== .. automodule:: alot.buffers - :members: BufferlistBuffer, EnvelopeBuffer,SearchBuffer,ThreadBuffer,TagListBuffer + :members: BufferlistBuffer, EnvelopeBuffer, NamedQueriesBuffer, SearchBuffer, ThreadBuffer, TagListBuffer Widgets -------- diff --git a/docs/source/configuration/key_bindings.rst b/docs/source/configuration/key_bindings.rst index fe8da87f..7f6e2787 100644 --- a/docs/source/configuration/key_bindings.rst +++ b/docs/source/configuration/key_bindings.rst @@ -21,11 +21,12 @@ and be able to toggle this tag in search mode, you'd add this to your config Known modes are: +* bufferlist * envelope +* namedqueries * search -* thread * taglist -* bufferlist +* thread Have a look at `the urwid User Input documentation `_ on how key strings are formatted. diff --git a/docs/source/usage/cli_commands.rst b/docs/source/usage/cli_commands.rst index b1b4b369..fdd9efc5 100644 --- a/docs/source/usage/cli_commands.rst +++ b/docs/source/usage/cli_commands.rst @@ -11,5 +11,8 @@ bufferlist taglist start with only a taglist buffer open +namedqueries + start with list of named queries + pyshell start the interactive python shell inside alot diff --git a/docs/source/usage/commands.rst b/docs/source/usage/commands.rst index 6fa99b58..96d66649 100644 --- a/docs/source/usage/commands.rst +++ b/docs/source/usage/commands.rst @@ -13,25 +13,28 @@ See the sections below for which commands are available in which (UI) mode. :doc:`modes/global` globally available commands -:doc:`modes/search` - commands available when showing thread search results -:doc:`modes/thread` - commands available while displaying a thread -:doc:`modes/envelope` - commands during message composition :doc:`modes/bufferlist` commands while listing active buffers +:doc:`modes/envelope` + commands during message composition +:doc:`modes/namedqueries` + commands while listing all named queries from the notmuch database +:doc:`modes/search` + commands available when showing thread search results :doc:`modes/taglist` commands while listing all tagstrings present in the notmuch database +:doc:`modes/thread` + commands available while displaying a thread .. toctree:: :maxdepth: 2 :hidden: modes/global - modes/search - modes/thread - modes/envelope modes/bufferlist + modes/envelope + modes/namedqueries + modes/search modes/taglist + modes/thread -- cgit v1.2.3