summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* docs: use sphinx's autodoc_mock_imports to mockPatrick Totzke2018-11-11
| | | | | .. out stuff whne building the docs instead of using homebrew methods. http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_mock_imports
* docs: Remove references to twistedDylan Baker2018-07-26
| | | | Except for an FAQ entry about it.
* Describe options the same way in help and manualAlexander Shpilkin2018-07-25
| | | | | The descriptions of --help and --version are the same as used in e.g. GNU coreutils (different from the Python default).
* Fix typo in documentationAlexander Shpilkin2018-07-25
|
* Reword description of options -C and colourmodeAlexander Shpilkin2018-07-25
|
* Avoid abbreviations in documentationAlexander Shpilkin2018-07-25
|
* Capitalize option and command descriptions consistentlyAlexander Shpilkin2018-07-25
|
* Fix typo in description of option -dAlexander Shpilkin2018-07-25
|
* Rewrap option descriptions in the manualAlexander Shpilkin2018-07-25
|
* Fix typesetting of option arguments in the manualAlexander Shpilkin2018-07-25
| | | | | | Sphinx appears to not typeset an option properly when only the long version lists an argument. Add the arguments to the short versions as well.
* update docsPatrick Totzke2018-07-24
|
* update docsPatrick Totzke2018-07-24
|
* Respect colour mode set in config fileAlexander Shpilkin2018-07-22
| | | | | | Terminal colour mode can be set both in the config file and on the command line, but a default value for the command-line option overrode whatever was specified in the config file. Fix this.
* simplify contributing infoPatrick Totzke2018-07-07
|
* provide retagprompt command in thread modeMichael J Gruber2018-06-22
| | | | | | | | | | | | retagprompt in search mode allows to retag a whole thread. The new thread mode version allows to do the same for each selected message. The common command infers its mode from the UI object that it is passed when applied. Therefore, the docstring (and everything else) is mode-agnostic. When this command command is registered for the wrong mode and applied it raises a KeyError (on purpose).
* Remove old __future__ importsLucas Hoffmann2018-06-19
| | | | They are not needed for python >= 3.0.
* Revert "docs: mock urwid.util"Dylan Baker2018-05-15
| | | | This reverts commit a86e346b0aed72f3a93d553ed699e0a89f4748e1.
* docs: mock urwid.utilDylan Baker2018-05-15
| | | | To allow the docs to build.
* Reformat a long statement in documentation code.Ben Finney2018-04-23
|
* Correct over-long comment lines in documentation code.Ben Finney2018-04-23
|
* Merge branch 'master' into py3kDylan Baker2018-03-05
|\ | | | | | | | | This requires regenerating the accounts_table docs, as they've changed for python 3.
| * implement replied and passed tagsMichael J Gruber2018-03-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | maildir knows R and P flags which denote messages that have been replied to resp. passed on (fowarded, bounced). They correspond to IMAP flags \Replied and $Forwarded which are used by many clients and by synchronisation software. E.g., mbsync syncs \Replied to R, a patch for P is pending. Implement replied_tags and passed_tags for alot which work similar to sent_tags: sent_tags tags the sent message; replied_tags (resp. passed_tags) tags the message being replied to (resp. being fowarded). Basically, setting the replied_tags config to `replied` and replying to a message has the same effect as doing `tag replied; reply`, but the latter would tag even sending the reply is aborted or fails. The implementation in this patch makes sure that the tagging is done only if and when the reply resp. forward has been sent successfully.
| * provide defaults and doc for draft_tagsMichael J Gruber2018-03-05
| | | | | | | | | | draft_tags works the same way as sent_tags, so provide the same defaults and doc.
| * remove superfluous list() for ConfigObjMichael J Gruber2018-03-05
| | | | | | | | | | | | force_list() converts single items to lists already. Thus, remove a superfluous list() that could be mistaken for converting a single string into a list of chars.
* | docs: regenerate again, hopefully for the last timeDylan Baker2018-03-01
| |
* | generate_commands: sort modecommands tooDylan Baker2018-03-01
| |
* | docs: regenerate generated sourcesDylan Baker2018-03-01
| |
* | docs: ensure configs are sorted as wellDylan Baker2018-03-01
| |
* | docs: sort modes in generate_commandsDylan Baker2018-03-01
| | | | | | | | | | otherwise the output is non-deterministic and the order will change with different versions of python.
* | Revert "docs: update generated docs"Dylan Baker2018-03-01
| | | | | | | | This reverts commit 5cd77e1a10bd92ed007218277791508df3b575e2.
* | docs: update generated docsDylan Baker2018-03-01
| | | | | | | | It seems like a bunch of stuff is now rendered in a different order.
* | docs: link against python 3.5 docs instead of 3.2Dylan Baker2018-03-01
| |
* | docs: fix installation docs for py3kDylan Baker2018-03-01
| |
* | docs: Update the FAQ for python 3Dylan Baker2018-03-01
|/
* Add --tags argument to compose commandJohannes Löthberg2018-02-12
| | | | Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
* Store settings in alot.rc.spec.Julian Mehne2018-01-21
| | | | | - allows users to use $XDG_CONFIG_HOME, as well - stores information in single places.
* Document the default values of template_dir and themes_dir.Julian Mehne2018-01-21
|
* Fix `:compose --template=foo` if default template_dir is used.Julian Mehne2018-01-21
| | | | | | | | | | | Fixes the following bug: To reproduce:: - Don't define `template_dir` in the user configuration file, such that the default value is used. - Run: :compose --template=foobar Problem: Displays error: `no template directory: $XDG_CONFIG_HOME/alot/templates`
* Merge pull request #1178 from GuillaumeSeren/upgrade-doc-dependies-gpgme-1.9.0Patrick Totzke2017-12-02
|\ | | | | Upgrade dependencies to GPGME >= 1.9.0
| * Upgrade doc dependencies to GPGME >= 1.9.0Guillaume Seren2017-12-01
| | | | | | | | | | | | | | This version of GPGME is needed to support the ':sign' and ':encrypt' commands, due to the migration of gpgme instead of pygpgme (#1086). https://github.com/pazz/alot/issues/1175
* | [docs] update section titlesPatrick Totzke2017-11-29
|/ | | | | this simply renames some (sub)section titles in the configuration docs.
* Merge pull request #1173 from pazz/feature-thread-indentPatrick Totzke2017-11-08
|\ | | | | thread mode message indentation
| * add config option for default threadmode indentationPatrick Totzke2017-11-05
| |
* | new config option 'exclude_tags'Patrick Totzke2017-10-01
|/ | | | | which will be interpreted just like 'search.exclude_tags' in the notmuch config.
* docs: Add encrypt_to_self account configurationRuben Pollan2017-09-26
|
* docs: Add Address classDylan Baker2017-08-28
|
* account: Add an Address classDylan Baker2017-08-28
| | | | | This class will encapsulate the logic of comparing email addresses and the rules of handling when capitalization is allowed and when it's not.
* fix example hookPatrick Totzke2017-08-27
| | | | | | This fixes the example "goodbye"-hook in order to make it work again with v0.6 and newer branches: the initializes SettingsManager object is now accessible as 'alot.settings.const.settings'.
* added senders search as an alternative ; more comments and links to docsYuri Subach2017-08-24
|
* Merge pull request #1125 from dcbaker/submit/deprecated-encrypt-by-defaultPatrick Totzke2017-08-20
|\ | | | | mark old options for encrypt_by_default as deprecated