diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2012-06-26 21:50:44 +0100 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-06-26 21:50:44 +0100 |
commit | c2d3ad9f539877294a031aae9ae410d0e96bf642 (patch) | |
tree | a9ac28d0503d694cffcaee73168e9bb1d96b6fdf /docs | |
parent | 1e66018acc312c9bec6c21ce25cd5cac91f6762d (diff) |
doc: fix warnings
this fixes uncritical warnings during the manual/api compilation:
* don't quote using backticks
* mark orphan docs as such
* don't refer to non-existant static files to be copied over
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/conf.py | 2 | ||||
-rw-r--r-- | docs/source/configuration/accounts_table.rst | 8 | ||||
-rw-r--r-- | docs/source/configuration/alotrc_table.rst | 30 | ||||
-rw-r--r-- | docs/source/description.rst | 2 | ||||
-rwxr-xr-x | docs/source/generate_commands.py | 2 | ||||
-rwxr-xr-x | docs/source/generate_configs.py | 8 | ||||
-rw-r--r-- | docs/source/manpage.rst | 2 | ||||
-rw-r--r-- | docs/source/usage/commands.rst | 2 | ||||
-rw-r--r-- | docs/source/usage/first_steps.rst | 2 | ||||
-rw-r--r-- | docs/source/usage/modes/bufferlist.rst | 2 | ||||
-rw-r--r-- | docs/source/usage/modes/envelope.rst | 4 | ||||
-rw-r--r-- | docs/source/usage/modes/global.rst | 2 | ||||
-rw-r--r-- | docs/source/usage/modes/search.rst | 2 | ||||
-rw-r--r-- | docs/source/usage/modes/taglist.rst | 2 | ||||
-rw-r--r-- | docs/source/usage/modes/thread.rst | 2 | ||||
-rw-r--r-- | docs/source/usage/synopsis.rst | 2 |
16 files changed, 51 insertions, 23 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index f32b22f7..24eb6a9c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -149,7 +149,7 @@ html_title = 'Alot User Manual' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/docs/source/configuration/accounts_table.rst b/docs/source/configuration/accounts_table.rst index 7fea81b6..7ac8d90f 100644 --- a/docs/source/configuration/accounts_table.rst +++ b/docs/source/configuration/accounts_table.rst @@ -1,5 +1,7 @@ -.. - CAUTION: THIS FILE IS AUTO-GENERATED + +:orphan: + +.. CAUTION: THIS FILE IS AUTO-GENERATED from the inline comments of specfile defaults/alot.rc.spec. If you want to change its content make your changes @@ -38,7 +40,7 @@ sendmail command. This is the shell command used to send out mails via the sendmail protocol :type: string - :default: `sendmail -t` + :default: "sendmail -t" .. _sent-box: diff --git a/docs/source/configuration/alotrc_table.rst b/docs/source/configuration/alotrc_table.rst index 567a9c74..e8d32966 100644 --- a/docs/source/configuration/alotrc_table.rst +++ b/docs/source/configuration/alotrc_table.rst @@ -1,5 +1,7 @@ -.. - CAUTION: THIS FILE IS AUTO-GENERATED + +:orphan: + +.. CAUTION: THIS FILE IS AUTO-GENERATED from the inline comments of specfile defaults/alot.rc.spec. If you want to change its content make your changes @@ -21,7 +23,7 @@ directory prefix for downloading attachments :type: string - :default: `~` + :default: "~" .. _authors-maxlength: @@ -174,7 +176,7 @@ file encoding used by your editor :type: string - :default: `UTF-8` + :default: "UTF-8" .. _envelope-headers-blacklist: @@ -220,7 +222,7 @@ only if original subject doesn't start with 'Fwd:' or this prefix :type: string - :default: `Fwd: ` + :default: "Fwd: " .. _hooksfile: @@ -230,7 +232,7 @@ where to look up hooks :type: string - :default: `~/.config/alot/hooks.py` + :default: "~/.config/alot/hooks.py" .. _initial-command: @@ -240,7 +242,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: @@ -273,7 +275,7 @@ Suffix of the prompt used when waiting for user input :type: string - :default: `:` + :default: ":" .. _quit-on-last-bclose: @@ -293,7 +295,7 @@ String prepended to line when quoting :type: string - :default: `> ` + :default: "> " .. _reply-subject-prefix: @@ -304,7 +306,7 @@ only if original subject doesn't start with 'Re:' or this prefix :type: string - :default: `Re: ` + :default: "Re: " .. _search-statusbar: @@ -375,7 +377,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: @@ -385,7 +387,7 @@ set terminal command used for spawning shell commands :type: string - :default: `x-terminal-emulator -e` + :default: "x-terminal-emulator -e" .. _theme: @@ -416,7 +418,7 @@ :ref:`thread_authors_replace_me <thread-authors-replace-me>` :type: string - :default: `Me` + :default: "Me" .. _thread-authors-replace-me: @@ -467,5 +469,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/description.rst b/docs/source/description.rst index 9dea9693..fa9148d2 100644 --- a/docs/source/description.rst +++ b/docs/source/description.rst @@ -1,3 +1,5 @@ +:orphan: + Alot is a terminal-based mail user agent for the notmuch mail system. It features a modular and command prompt driven interface to provide a full MUA experience as an alternative to the Emacs mode shipped diff --git a/docs/source/generate_commands.py b/docs/source/generate_commands.py index eb241d10..0846347e 100755 --- a/docs/source/generate_commands.py +++ b/docs/source/generate_commands.py @@ -15,7 +15,7 @@ import re as _re import sys as _sys import textwrap as _textwrap -NOTE = ".. CAUTION: THIS FILE IS AUTO-GENERATED!\n\n\n" +NOTE = ":orphan:\n\n.. CAUTION: THIS FILE IS AUTO-GENERATED!\n\n\n" class HF(HelpFormatter): def _metavar_formatter(self, action, default_metavar): diff --git a/docs/source/generate_configs.py b/docs/source/generate_configs.py index b39191dd..f7776ee3 100755 --- a/docs/source/generate_configs.py +++ b/docs/source/generate_configs.py @@ -6,8 +6,10 @@ from alot.commands import COMMANDS from configobj import ConfigObj from validate import Validator import re -NOTE = """.. - CAUTION: THIS FILE IS AUTO-GENERATED +NOTE = """ +:orphan: + +.. CAUTION: THIS FILE IS AUTO-GENERATED from the inline comments of specfile %s. If you want to change its content make your changes @@ -49,7 +51,7 @@ def rewrite_entries(config, path, specpath, sec=None, sort=False): if default != None: default = default.replace('*','\\*') if etype in ['string', 'string_list', 'gpg_key_hint'] 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) diff --git a/docs/source/manpage.rst b/docs/source/manpage.rst index 0e53d82b..6ff0624e 100644 --- a/docs/source/manpage.rst +++ b/docs/source/manpage.rst @@ -1,3 +1,5 @@ +:orphan: + Manpage ======= diff --git a/docs/source/usage/commands.rst b/docs/source/usage/commands.rst index bc93ac1a..9117ed18 100644 --- a/docs/source/usage/commands.rst +++ b/docs/source/usage/commands.rst @@ -1,3 +1,5 @@ +:orphan: + Commands ======== diff --git a/docs/source/usage/first_steps.rst b/docs/source/usage/first_steps.rst index e99c44ce..7a4d275c 100644 --- a/docs/source/usage/first_steps.rst +++ b/docs/source/usage/first_steps.rst @@ -1,3 +1,5 @@ +:orphan: + The arrow keys, `page-up/down`, `j`, `k` and `Space` can be used to move the focus. `Escape` cancels prompts and `Enter` selects. Hit `:` at any time and type in commands to the prompt. diff --git a/docs/source/usage/modes/bufferlist.rst b/docs/source/usage/modes/bufferlist.rst index 3028916e..42e596c7 100644 --- a/docs/source/usage/modes/bufferlist.rst +++ b/docs/source/usage/modes/bufferlist.rst @@ -1,3 +1,5 @@ +:orphan: + .. CAUTION: THIS FILE IS AUTO-GENERATED! diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst index 126178fa..ffa2ddee 100644 --- a/docs/source/usage/modes/envelope.rst +++ b/docs/source/usage/modes/envelope.rst @@ -1,3 +1,5 @@ +:orphan: + .. CAUTION: THIS FILE IS AUTO-GENERATED! @@ -51,7 +53,7 @@ ____ edit mail optional arguments - :---spawn: force spawning of editor in a new terminal. + :---spawn: spawn editor in new terminal. :---refocus: refocus envelope after editing (Defaults to: 'True'). .. _cmd_envelope_send: diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst index 58ea6383..c4364505 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -1,3 +1,5 @@ +:orphan: + .. CAUTION: THIS FILE IS AUTO-GENERATED! diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst index 16404cf4..f2c95cc7 100644 --- a/docs/source/usage/modes/search.rst +++ b/docs/source/usage/modes/search.rst @@ -1,3 +1,5 @@ +:orphan: + .. CAUTION: THIS FILE IS AUTO-GENERATED! diff --git a/docs/source/usage/modes/taglist.rst b/docs/source/usage/modes/taglist.rst index c6f7198b..85df5f9f 100644 --- a/docs/source/usage/modes/taglist.rst +++ b/docs/source/usage/modes/taglist.rst @@ -1,3 +1,5 @@ +:orphan: + .. CAUTION: THIS FILE IS AUTO-GENERATED! diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst index 096d7c20..ec8ccd4f 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -1,3 +1,5 @@ +:orphan: + .. CAUTION: THIS FILE IS AUTO-GENERATED! diff --git a/docs/source/usage/synopsis.rst b/docs/source/usage/synopsis.rst index 5bfb8e88..2e335902 100644 --- a/docs/source/usage/synopsis.rst +++ b/docs/source/usage/synopsis.rst @@ -1,3 +1,5 @@ +:orphan: + .. code-block:: none alot [-r] [-c CONFIGFILE] [-n NOTMUCHCONFIGFILE] [-C {1,16,256}] [-p DB_PATH] |