docs: fix build warnings

5 files changed, 42 insertions, 23 deletions

diff --git a/alot/db/utils.py b/alot/db/utils.py
index 9846474f..0d28783f 100644
--- a/alot/db/utils.py
+++ b/alot/db/utils.py
@@ -41,9 +41,9 @@ def extract_headers(mail, headers=None):
 def extract_body(mail, types=None):
     """
     returns a body text string for given mail.
-    If types is `None`, 'text/*' is used:
-    In case mail has a 'text/html' part, it is prefered over
-    'text/plain' parts.
+    If types is `None`, `text/*` is used:
+    In case mail has a `text/html` part, it is prefered over
+    `text/plain` parts.
 
     :param mail: the mail to use
     :type mail: :class:`email.Message`
diff --git a/alot/defaults/alot.rc.spec b/alot/defaults/alot.rc.spec
index 1470393d..b3927844 100644
--- a/alot/defaults/alot.rc.spec
+++ b/alot/defaults/alot.rc.spec
@@ -44,7 +44,7 @@ thread_authors_me = string(default='Me')
 terminal_cmd = string(default='x-terminal-emulator -e')
 
 # editor command
-# if unset, alot will first try the :env:`EDITOR` env variable, then :file:`/usr/bin/editor`
+# if unset, alot will first try the :envvar:`EDITOR` env variable, then :file:`/usr/bin/editor`
 editor_cmd = string(default=None)
 
 # file encoding used by your editor
diff --git a/docs/source/configuration/accounts_table.rst b/docs/source/configuration/accounts_table.rst
index d784b803..ee12873f 100644
--- a/docs/source/configuration/accounts_table.rst
+++ b/docs/source/configuration/accounts_table.rst
@@ -22,7 +22,7 @@
     used to clear your addresses/ match account when formatting replies
 
     :type: string_list
-    :default: ","
+    :default: `,`
 
 
 .. _sendmail-command:
@@ -32,18 +32,27 @@
     sendmail command. This is the shell command used to send out mails via the sendmail protocol
 
     :type: string
-    :default: "sendmail"
+    :default: `sendmail`
 
 
 .. _sent-box:
 
 .. describe:: sent_box
 
-    specifies the mailbox where you want outgoing mails to be stored after successfully sending them, e.g. 
-    where to store outgoing mail, e.g. `maildir:///home/you/mail//Sent`
+    where to store outgoing mails, e.g. `maildir:///home/you/mail//Sent`
     You can use mbox, maildir, mh, babyl and mmdf in the protocol part of the URL.
 
-    :type: string
+    :type: mail_container
+    :default: None
+
+
+.. _draft-box:
+
+.. describe:: draft_box
+
+    where to store draft mails, see :ref:`sent_box <sent-box>` for the format
+
+    :type: mail_container
     :default: None
 
 
@@ -54,7 +63,7 @@
     list of tags to automatically add to outgoing messages
 
     :type: string_list
-    :default: "sent,"
+    :default: `sent,`
 
 
 .. _signature:
diff --git a/docs/source/configuration/alotrc_table.rst b/docs/source/configuration/alotrc_table.rst
index bcfb9230..e776a837 100644
--- a/docs/source/configuration/alotrc_table.rst
+++ b/docs/source/configuration/alotrc_table.rst
@@ -77,7 +77,7 @@
     headers that get displayed by default
 
     :type: string_list
-    :default: "From, To, Cc, Bcc, Subject"
+    :default: `From, To, Cc, Bcc, Subject`
 
 
 .. _edit-headers-blacklist:
@@ -87,7 +87,7 @@
     see :ref:`edit_headers_whitelist <edit-headers-whitelist>`
 
     :type: string_list
-    :default: "Content-Type, MIME-Version, References, In-Reply-To"
+    :default: `Content-Type, MIME-Version, References, In-Reply-To`
 
 
 .. _edit-headers-whitelist:
@@ -99,7 +99,7 @@
     in both cases '*' may be used to indicate all fields.
 
     :type: string_list
-    :default: "*,"
+    :default: `*,`
 
 
 .. _editor-cmd:
@@ -107,7 +107,7 @@
 .. describe:: editor_cmd
 
     editor command
-    if unset, alot will first try the :env:`EDITOR` env variable, then :file:`/usr/bin/editor`
+    if unset, alot will first try the :envvar:`EDITOR` env variable, then :file:`/usr/bin/editor`
 
     :type: string
     :default: None
@@ -142,7 +142,7 @@
     file encoding used by your editor
 
     :type: string
-    :default: "UTF-8"
+    :default: `UTF-8`
 
 
 .. _envelope-headers-blacklist:
@@ -152,7 +152,7 @@
     headers that are hidden in envelope buffers by default
 
     :type: string_list
-    :default: "In-Reply-To, References"
+    :default: `In-Reply-To, References`
 
 
 .. _flush-retry-timeout:
@@ -172,7 +172,7 @@
     where to look up hooks
 
     :type: string
-    :default: "~/.config/alot/hooks.py"
+    :default: `~/.config/alot/hooks.py`
 
 
 .. _initial-command:
@@ -182,7 +182,7 @@
     initial command when none is given as argument:
 
     :type: string
-    :default: "search tag:inbox AND NOT tag:killed"
+    :default: `search tag:inbox AND NOT tag:killed`
 
 
 .. _notify-timeout:
@@ -208,6 +208,16 @@
     :default: None
 
 
+.. _prompt-suffix:
+
+.. describe:: prompt_suffix
+
+    Suffix of the prompt used when waiting for user input
+
+    :type: string
+    :default: `:`
+
+
 .. _quit-on-last-bclose:
 
 .. describe:: quit_on_last_bclose
@@ -256,7 +266,7 @@
     It will be used if you give `compose --template` a filename without a path prefix.
 
     :type: string
-    :default: "$XDG_CONFIG_HOME/alot/templates"
+    :default: `$XDG_CONFIG_HOME/alot/templates`
 
 
 .. _terminal-cmd:
@@ -266,7 +276,7 @@
     set terminal command used for spawning shell commands
 
     :type: string
-    :default: "x-terminal-emulator -e"
+    :default: `x-terminal-emulator -e`
 
 
 .. _theme:
@@ -297,7 +307,7 @@
     :ref:`thread_authors_replace_me <thread-authors-replace-me>`
 
     :type: string
-    :default: "Me"
+    :default: `Me`
 
 
 .. _thread-authors-replace-me:
@@ -330,5 +340,5 @@
     The string '{version}' will be replaced by the version string of the running instance.
 
     :type: string
-    :default: "alot/{version}"
+    :default: `alot/{version}`
 
diff --git a/docs/source/generate_configs.py b/docs/source/generate_configs.py
index 3be1043d..c10b7926 100755
--- a/docs/source/generate_configs.py
+++ b/docs/source/generate_configs.py
@@ -38,7 +38,7 @@ def rewrite_entries(config, path, sec=None, sort=False):
 
         if default != None:
             if etype in ['string', 'string_list'] and default != 'None':
-                description += '    :default: "%s"\n\n' % (default)
+                description += '    :default: `%s`\n\n' % (default)
             else:
                 description += '    :default: %s\n\n' % (default)
         file.write(description)