Revert "docs: update generated docs"

This reverts commit 5cd77e1a10bd92ed007218277791508df3b575e2.

5 files changed, 318 insertions, 318 deletions

diff --git a/docs/source/usage/modes/bufferlist.rst b/docs/source/usage/modes/bufferlist.rst
index c8be65c1..7de661e9 100644
--- a/docs/source/usage/modes/bufferlist.rst
+++ b/docs/source/usage/modes/bufferlist.rst
@@ -5,17 +5,17 @@ Commands in `bufferlist` mode
 -----------------------------
 The following commands are available in bufferlist mode
 
-.. _cmd.bufferlist.open:
+.. _cmd.bufferlist.close:
 
-.. describe:: open
+.. describe:: close
 
-    focus selected buffer
+    close focussed buffer
 
 
-.. _cmd.bufferlist.close:
+.. _cmd.bufferlist.open:
 
-.. describe:: close
+.. describe:: open
 
-    close focussed buffer
+    focus selected buffer
 
 
diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst
index be612216..8644a6c1 100644
--- a/docs/source/usage/modes/envelope.rst
+++ b/docs/source/usage/modes/envelope.rst
@@ -5,62 +5,65 @@ Commands in `envelope` mode
 ---------------------------
 The following commands are available in envelope mode
 
-.. _cmd.envelope.edit:
+.. _cmd.envelope.unencrypt:
 
-.. describe:: edit
+.. describe:: unencrypt
 
-    edit mail
+    remove request to encrypt message before sending
 
-    optional arguments
-        :---spawn: spawn editor in new terminal.
-        :---refocus: refocus envelope after editing (Defaults to: 'True').
 
-.. _cmd.envelope.save:
+.. _cmd.envelope.set:
 
-.. describe:: save
+.. describe:: set
 
-    save draft
+    set header value
 
+    positional arguments
+        0: header to refine
+        1: value
 
-.. _cmd.envelope.rmencrypt:
 
-.. describe:: rmencrypt
+    optional arguments
+        :---append: keep previous values.
 
-    do not encrypt to given recipient key
+.. _cmd.envelope.encrypt:
+
+.. describe:: encrypt
+
+    request encryption of message before sendout
 
     argument
         keyid of the key to encrypt with
 
+    optional arguments
+        :---trusted: only add trusted keys.
 
-.. _cmd.envelope.tag:
+.. _cmd.envelope.togglesign:
 
-.. describe:: tag
+.. describe:: togglesign
 
-    add tags to message
+    toggle sign status
 
     argument
-        comma separated list of tags
-
-
-.. _cmd.envelope.refine:
+        which key id to use
 
-.. describe:: refine
 
-    prompt to change the value of a header
+.. _cmd.envelope.toggleheaders:
 
-    argument
-        header to refine
+.. describe:: toggleheaders
 
+    toggle display of all headers
 
-.. _cmd.envelope.togglesign:
 
-.. describe:: togglesign
+.. _cmd.envelope.edit:
 
-    toggle sign status
+.. describe:: edit
 
-    argument
-        which key id to use
+    edit mail
 
+    optional arguments
+        :---spawn: spawn editor in new terminal.
+        :---refocus: refocus envelope after editing (Defaults to: 'True').
 
 .. _cmd.envelope.retag:
 
@@ -72,43 +75,41 @@ The following commands are available in envelope mode
         comma separated list of tags
 
 
-.. _cmd.envelope.unattach:
+.. _cmd.envelope.tag:
 
-.. describe:: unattach
+.. describe:: tag
 
-    remove attachments from current envelope
+    add tags to message
 
     argument
-        which attached file to remove
+        comma separated list of tags
 
 
-.. _cmd.envelope.toggleheaders:
+.. _cmd.envelope.send:
 
-.. describe:: toggleheaders
+.. describe:: send
 
-    toggle display of all headers
+    send mail
 
 
-.. _cmd.envelope.encrypt:
+.. _cmd.envelope.sign:
 
-.. describe:: encrypt
+.. describe:: sign
 
-    request encryption of message before sendout
+    mark mail to be signed before sending
 
     argument
-        keyid of the key to encrypt with
+        which key id to use
 
-    optional arguments
-        :---trusted: only add trusted keys.
 
-.. _cmd.envelope.unset:
+.. _cmd.envelope.untag:
 
-.. describe:: unset
+.. describe:: untag
 
-    remove header field
+    remove tags from message
 
     argument
-        header to refine
+        comma separated list of tags
 
 
 .. _cmd.envelope.attach:
@@ -121,57 +122,60 @@ The following commands are available in envelope mode
         file(s) to attach (accepts wildcads)
 
 
-.. _cmd.envelope.toggleencrypt:
+.. _cmd.envelope.unattach:
 
-.. describe:: toggleencrypt
+.. describe:: unattach
 
-    toggle if message should be encrypted before sendout
+    remove attachments from current envelope
 
     argument
-        keyid of the key to encrypt with
+        which attached file to remove
 
-    optional arguments
-        :---trusted: only add trusted keys.
 
-.. _cmd.envelope.untag:
+.. _cmd.envelope.rmencrypt:
 
-.. describe:: untag
+.. describe:: rmencrypt
 
-    remove tags from message
+    do not encrypt to given recipient key
 
     argument
-        comma separated list of tags
+        keyid of the key to encrypt with
 
 
-.. _cmd.envelope.sign:
+.. _cmd.envelope.refine:
 
-.. describe:: sign
+.. describe:: refine
 
-    mark mail to be signed before sending
+    prompt to change the value of a header
 
     argument
-        which key id to use
-
+        header to refine
 
-.. _cmd.envelope.set:
 
-.. describe:: set
+.. _cmd.envelope.toggleencrypt:
 
-    set header value
+.. describe:: toggleencrypt
 
-    positional arguments
-        0: header to refine
-        1: value
+    toggle if message should be encrypted before sendout
 
+    argument
+        keyid of the key to encrypt with
 
     optional arguments
-        :---append: keep previous values.
+        :---trusted: only add trusted keys.
 
-.. _cmd.envelope.unencrypt:
+.. _cmd.envelope.save:
 
-.. describe:: unencrypt
+.. describe:: save
 
-    remove request to encrypt message before sending
+    save draft
+
+
+.. _cmd.envelope.unsign:
+
+.. describe:: unsign
+
+    mark mail not to be signed before sending
 
 
 .. _cmd.envelope.toggletags:
@@ -184,17 +188,13 @@ The following commands are available in envelope mode
         comma separated list of tags
 
 
-.. _cmd.envelope.unsign:
-
-.. describe:: unsign
-
-    mark mail not to be signed before sending
-
+.. _cmd.envelope.unset:
 
-.. _cmd.envelope.send:
+.. describe:: unset
 
-.. describe:: send
+    remove header field
 
-    send mail
+    argument
+        header to refine
 
 
diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst
index 672e43d5..dcbe4040 100644
--- a/docs/source/usage/modes/global.rst
+++ b/docs/source/usage/modes/global.rst
@@ -5,40 +5,21 @@ Global Commands
 ---------------
 The following commands are available globally
 
-.. _cmd.global.call:
-
-.. describe:: call
-
-    Executes python code
-
-    argument
-        python command string to call
-
-
-.. _cmd.global.refresh:
-
-.. describe:: refresh
-
-    refresh the current buffer
-
-
-.. _cmd.global.exit:
-
-.. describe:: exit
+.. _cmd.global.bclose:
 
-    Shut down cleanly.
+.. describe:: bclose
 
-    The _prompt variable is for internal use only, it's used to control
-    prompting to close without sending, and is used by the BufferCloseCommand
-    if settings change after yielding to the UI.
-    
+    close a buffer
 
+    optional arguments
+        :---redraw: redraw current buffer after command has finished.
+        :---force: never ask for confirmation.
 
-.. _cmd.global.flush:
+.. _cmd.global.bprevious:
 
-.. describe:: flush
+.. describe:: bprevious
 
-    flush write operations or retry until committed
+    focus previous buffer
 
 
 .. _cmd.global.search:
@@ -54,52 +35,53 @@ The following commands are available globally
     optional arguments
         :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.
 
-.. _cmd.global.move:
+.. _cmd.global.repeat:
 
-.. describe:: move
+.. describe:: repeat
 
-    move focus in current buffer
+    Repeats the command executed last time
+
+
+.. _cmd.global.prompt:
+
+.. describe:: prompt
+
+    prompts for commandline and interprets it upon select
 
     argument
-        up, down, [half]page up, [half]page down, first, last
+        initial content
 
 
-.. _cmd.global.taglist:
+.. _cmd.global.help:
 
-.. describe:: taglist
+.. describe:: help
 
-    opens taglist buffer
+    display help for a command. Use 'bindings' to display all keybings
+    interpreted in current mode.'
 
-    optional arguments
-        :---tags: tags to display.
+    argument
+        command or 'bindings'
 
-.. _cmd.global.bufferlist:
 
-.. describe:: bufferlist
+.. _cmd.global.buffer:
 
-    open a list of active buffers
+.. describe:: buffer
 
+    focus buffer with given index
 
-.. _cmd.global.compose:
+    argument
+        buffer index to focus
 
-.. describe:: compose
 
-    compose a new email
+.. _cmd.global.move:
+
+.. describe:: move
+
+    move focus in current buffer
 
     argument
-        None
+        up, down, [half]page up, [half]page down, first, last
 
-    optional arguments
-        :---sender: sender.
-        :---template: path to a template message file.
-        :---tags: comma-separated list of tags to apply to message.
-        :---subject: subject line.
-        :---to: recipients.
-        :---cc: copy to.
-        :---bcc: blind copy to.
-        :---attach: attach files.
-        :---omit_signature: do not add signature.
-        :---spawn: spawn editor in new terminal.
 
 .. _cmd.global.shellescape:
 
@@ -115,79 +97,97 @@ The following commands are available globally
         :---thread: run in separate thread.
         :---refocus: refocus current buffer after command has finished.
 
-.. _cmd.global.bprevious:
+.. _cmd.global.refresh:
 
-.. describe:: bprevious
+.. describe:: refresh
 
-    focus previous buffer
+    refresh the current buffer
 
 
-.. _cmd.global.prompt:
+.. _cmd.global.reload:
 
-.. describe:: prompt
+.. describe:: reload
 
-    prompts for commandline and interprets it upon select
+    Reload all configuration files
 
-    argument
-        initial content
 
+.. _cmd.global.pyshell:
 
-.. _cmd.global.help:
+.. describe:: pyshell
 
-.. describe:: help
+    open an interactive python shell for introspection
 
-    display help for a command. Use 'bindings' to display all keybings
-    interpreted in current mode.'
+
+.. _cmd.global.compose:
+
+.. describe:: compose
+
+    compose a new email
 
     argument
-        command or 'bindings'
+        None
 
+    optional arguments
+        :---sender: sender.
+        :---template: path to a template message file.
+        :---tags: comma-separated list of tags to apply to message.
+        :---subject: subject line.
+        :---to: recipients.
+        :---cc: copy to.
+        :---bcc: blind copy to.
+        :---attach: attach files.
+        :---omit_signature: do not add signature.
+        :---spawn: spawn editor in new terminal.
 
-.. _cmd.global.bclose:
+.. _cmd.global.exit:
 
-.. describe:: bclose
+.. describe:: exit
 
-    close a buffer
+    Shut down cleanly.
 
-    optional arguments
-        :---redraw: redraw current buffer after command has finished.
-        :---force: never ask for confirmation.
+    The _prompt variable is for internal use only, it's used to control
+    prompting to close without sending, and is used by the BufferCloseCommand
+    if settings change after yielding to the UI.
+    
 
-.. _cmd.global.repeat:
 
-.. describe:: repeat
+.. _cmd.global.flush:
 
-    Repeats the command executed last time
+.. describe:: flush
 
+    flush write operations or retry until committed
 
-.. _cmd.global.bnext:
 
-.. describe:: bnext
+.. _cmd.global.bufferlist:
 
-    focus next buffer
+.. describe:: bufferlist
 
+    open a list of active buffers
 
-.. _cmd.global.buffer:
 
-.. describe:: buffer
+.. _cmd.global.call:
 
-    focus buffer with given index
+.. describe:: call
+
+    Executes python code
 
     argument
-        buffer index to focus
+        python command string to call
 
 
-.. _cmd.global.reload:
+.. _cmd.global.bnext:
 
-.. describe:: reload
+.. describe:: bnext
 
-    Reload all configuration files
+    focus next buffer
 
 
-.. _cmd.global.pyshell:
+.. _cmd.global.taglist:
 
-.. describe:: pyshell
+.. describe:: taglist
 
-    open an interactive python shell for introspection
+    opens taglist buffer
 
+    optional arguments
+        :---tags: tags to display.
 
diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst
index 5dbd0abc..93a59eff 100644
--- a/docs/source/usage/modes/search.rst
+++ b/docs/source/usage/modes/search.rst
@@ -5,19 +5,6 @@ Commands in `search` mode
 -------------------------
 The following commands are available in search mode
 
-.. _cmd.search.retag:
-
-.. describe:: retag
-
-    set tags of all messages in the thread that match the current query
-
-    argument
-        comma separated list of tags
-
-    optional arguments
-        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
-        :---all: retag all messages in search result.
-
 .. _cmd.search.sort:
 
 .. describe:: sort
@@ -28,32 +15,6 @@ The following commands are available in search mode
         sort order. valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.
 
 
-.. _cmd.search.retagprompt:
-
-.. describe:: retagprompt
-
-    prompt to retag selected threads' tags
-
-
-.. _cmd.search.select:
-
-.. describe:: select
-
-    open thread in a new buffer
-
-
-.. _cmd.search.refine:
-
-.. describe:: refine
-
-    refine query
-
-    argument
-        search string
-
-    optional arguments
-        :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.
-
 .. _cmd.search.untag:
 
 .. describe:: untag
@@ -77,17 +38,25 @@ The following commands are available in search mode
         last
 
 
-.. _cmd.search.toggletags:
+.. _cmd.search.retag:
 
-.. describe:: toggletags
+.. describe:: retag
 
-    flip presence of tags on this thread. A tag is considered present if at least one message contained in this thread is tagged with it. In that case this command will remove the tag from every message in the thread.
+    set tags of all messages in the thread that match the current query
 
     argument
         comma separated list of tags
 
     optional arguments
         :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+        :---all: retag all messages in search result.
+
+.. _cmd.search.refineprompt:
+
+.. describe:: refineprompt
+
+    prompt to change this buffers querystring
+
 
 .. _cmd.search.tag:
 
@@ -102,10 +71,41 @@ The following commands are available in search mode
         :---no-flush: postpone a writeout to the index (Defaults to: 'True').
         :---all: retag all messages in search result.
 
-.. _cmd.search.refineprompt:
+.. _cmd.search.refine:
 
-.. describe:: refineprompt
+.. describe:: refine
 
-    prompt to change this buffers querystring
+    refine query
+
+    argument
+        search string
+
+    optional arguments
+        :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.
+
+.. _cmd.search.retagprompt:
+
+.. describe:: retagprompt
+
+    prompt to retag selected threads' tags
+
+
+.. _cmd.search.toggletags:
+
+.. describe:: toggletags
+
+    flip presence of tags on this thread. A tag is considered present if at least one message contained in this thread is tagged with it. In that case this command will remove the tag from every message in the thread.
+
+    argument
+        comma separated list of tags
+
+    optional arguments
+        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
+.. _cmd.search.select:
+
+.. describe:: select
+
+    open thread in a new buffer
 
 
diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst
index 7e98e327..29a7850a 100644
--- a/docs/source/usage/modes/thread.rst
+++ b/docs/source/usage/modes/thread.rst
@@ -5,50 +5,69 @@ Commands in `thread` mode
 -------------------------
 The following commands are available in thread mode
 
-.. _cmd.thread.indent:
+.. _cmd.thread.pipeto:
 
-.. describe:: indent
+.. describe:: pipeto
 
-    change message/reply indentation
+    pipe message(s) to stdin of a shellcommand
 
     argument
-        None
+        shellcommand to pipe to
 
+    optional arguments
+        :---all: pass all messages.
+        :---format: output format. Valid choices are: \`raw\`,\`decoded\`,\`id\`,\`filepath\` (Defaults to: 'raw').
+        :---separately: call command once for each message.
+        :---background: don't stop the interface.
+        :---add_tags: add 'Tags' header to the message.
+        :---shell: let the shell interpret the command.
+        :---notify_stdout: display cmd's stdout as notification.
+        :---field_key: mailcap field key for decoding (Defaults to: 'copiousoutput').
 
-.. _cmd.thread.unfold:
+.. _cmd.thread.editnew:
 
-.. describe:: unfold
+.. describe:: editnew
 
-    unfold message(s)
+    edit message in as new
+
+    optional arguments
+        :---spawn: open editor in new window.
+
+.. _cmd.thread.move:
+
+.. describe:: move
+
+    move focus in current buffer
 
     argument
-        query used to filter messages to affect
+        up, down, [half]page up, [half]page down, first, last,                   parent, first reply, last reply,                   next sibling, previous sibling, next, previous,                   next unfolded, previous unfolded,                   next NOTMUCH_QUERY, previous NOTMUCH_QUERY
 
 
-.. _cmd.thread.toggleheaders:
+.. _cmd.thread.indent:
 
-.. describe:: toggleheaders
+.. describe:: indent
 
-    display all headers
+    change message/reply indentation
 
     argument
-        query used to filter messages to affect
+        None
 
 
-.. _cmd.thread.editnew:
+.. _cmd.thread.toggleheaders:
 
-.. describe:: editnew
+.. describe:: toggleheaders
 
-    edit message in as new
+    display all headers
 
-    optional arguments
-        :---spawn: open editor in new window.
+    argument
+        query used to filter messages to affect
 
-.. _cmd.thread.tag:
 
-.. describe:: tag
+.. _cmd.thread.retag:
 
-    add tags to message(s)
+.. describe:: retag
+
+    set message(s) tags.
 
     argument
         comma separated list of tags
@@ -57,34 +76,34 @@ The following commands are available in thread mode
         :---all: tag all messages in thread.
         :---no-flush: postpone a writeout to the index (Defaults to: 'True').
 
-.. _cmd.thread.forward:
+.. _cmd.thread.print:
 
-.. describe:: forward
+.. describe:: print
 
-    forward message
+    print message(s)
 
     optional arguments
-        :---attach: attach original mail.
-        :---spawn: open editor in new window.
+        :---all: print all messages.
+        :---raw: pass raw mail string.
+        :---separately: call print command once for each message.
+        :---add_tags: add 'Tags' header to the message.
 
-.. _cmd.thread.pipeto:
+.. _cmd.thread.bounce:
 
-.. describe:: pipeto
+.. describe:: bounce
 
-    pipe message(s) to stdin of a shellcommand
+    directly re-send selected message
+
+
+.. _cmd.thread.togglesource:
+
+.. describe:: togglesource
+
+    display message source
 
     argument
-        shellcommand to pipe to
+        query used to filter messages to affect
 
-    optional arguments
-        :---all: pass all messages.
-        :---format: output format. Valid choices are: \`raw\`,\`decoded\`,\`id\`,\`filepath\` (Defaults to: 'raw').
-        :---separately: call command once for each message.
-        :---background: don't stop the interface.
-        :---add_tags: add 'Tags' header to the message.
-        :---shell: let the shell interpret the command.
-        :---notify_stdout: display cmd's stdout as notification.
-        :---field_key: mailcap field key for decoding (Defaults to: 'copiousoutput').
 
 .. _cmd.thread.untag:
 
@@ -99,35 +118,6 @@ The following commands are available in thread mode
         :---all: tag all messages in thread.
         :---no-flush: postpone a writeout to the index (Defaults to: 'True').
 
-.. _cmd.thread.remove:
-
-.. describe:: remove
-
-    remove message(s) from the index
-
-    optional arguments
-        :---all: remove whole thread.
-
-.. _cmd.thread.reply:
-
-.. describe:: reply
-
-    reply to message
-
-    optional arguments
-        :---all: reply to all.
-        :---list: reply to list.
-        :---spawn: open editor in new window.
-
-.. _cmd.thread.select:
-
-.. describe:: select
-
-    select focussed element. The fired action depends on the focus:
-        - if message summary, this toggles visibility of the message,
-        - if attachment line, this opens the attachment
-
-
 .. _cmd.thread.fold:
 
 .. describe:: fold
@@ -138,11 +128,11 @@ The following commands are available in thread mode
         query used to filter messages to affect
 
 
-.. _cmd.thread.retag:
+.. _cmd.thread.tag:
 
-.. describe:: retag
+.. describe:: tag
 
-    set message(s) tags.
+    add tags to message(s)
 
     argument
         comma separated list of tags
@@ -151,47 +141,45 @@ The following commands are available in thread mode
         :---all: tag all messages in thread.
         :---no-flush: postpone a writeout to the index (Defaults to: 'True').
 
-.. _cmd.thread.bounce:
-
-.. describe:: bounce
-
-    directly re-send selected message
-
-
-.. _cmd.thread.print:
+.. _cmd.thread.remove:
 
-.. describe:: print
+.. describe:: remove
 
-    print message(s)
+    remove message(s) from the index
 
     optional arguments
-        :---all: print all messages.
-        :---raw: pass raw mail string.
-        :---separately: call print command once for each message.
-        :---add_tags: add 'Tags' header to the message.
+        :---all: remove whole thread.
 
-.. _cmd.thread.togglesource:
+.. _cmd.thread.unfold:
 
-.. describe:: togglesource
+.. describe:: unfold
 
-    display message source
+    unfold message(s)
 
     argument
         query used to filter messages to affect
 
 
-.. _cmd.thread.toggletags:
+.. _cmd.thread.forward:
 
-.. describe:: toggletags
+.. describe:: forward
 
-    flip presence of tags on message(s)
+    forward message
 
-    argument
-        comma separated list of tags
+    optional arguments
+        :---attach: attach original mail.
+        :---spawn: open editor in new window.
+
+.. _cmd.thread.reply:
+
+.. describe:: reply
+
+    reply to message
 
     optional arguments
-        :---all: tag all messages in thread.
-        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+        :---all: reply to all.
+        :---list: reply to list.
+        :---spawn: open editor in new window.
 
 .. _cmd.thread.save:
 
@@ -205,13 +193,25 @@ The following commands are available in thread mode
     optional arguments
         :---all: save all attachments.
 
-.. _cmd.thread.move:
+.. _cmd.thread.toggletags:
 
-.. describe:: move
+.. describe:: toggletags
 
-    move focus in current buffer
+    flip presence of tags on message(s)
 
     argument
-        up, down, [half]page up, [half]page down, first, last,                   parent, first reply, last reply,                   next sibling, previous sibling, next, previous,                   next unfolded, previous unfolded,                   next NOTMUCH_QUERY, previous NOTMUCH_QUERY
+        comma separated list of tags
+
+    optional arguments
+        :---all: tag all messages in thread.
+        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
+.. _cmd.thread.select:
+
+.. describe:: select
+
+    select focussed element. The fired action depends on the focus:
+        - if message summary, this toggles visibility of the message,
+        - if attachment line, this opens the attachment