summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* docs: Update docstrings for move commandsLucas Hoffmann2017-08-05
|
* docs: mention 'content' part in threadline themingPatrick Totzke2017-08-04
| | | | | ... which displays a prefix of the msg contents. This feature was missing in the docs.
* Merge pull request #1097 from lucc/scriptsLucas Hoffmann2017-08-02
|\ | | | | Clean up doc source generators
| * Clean up doc source generatorsLucas Hoffmann2017-07-31
| |
* | docs: Note that system paths can contain themesDylan Baker2017-07-27
|/ | | | Since the original patch that added the support didn't.
* Update documentation for :tag commands in envelope buffersLucas Hoffmann2017-07-11
|
* Add a reload commandDylan Baker2017-07-10
| | | | | | | This command allows the configuration to be reloaded while alot is running. Fixes #1046
* Exclude search.exclude_tags from searchesJohannes Löthberg2017-06-08
| | | | | | Fixes #707 and #332. Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
* docs: Remove spurious reference _account in config_optionsJohannes Löthberg2017-06-06
| | | | Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
* Indicate usage of notmuch config file correctlyLucas Hoffmann2017-06-03
|
* update FAQPatrick Totzke2017-06-01
|
* docs: Fix sphinx warnings (and build) on sphinx > 1.5.1Dylan Baker2017-05-30
| | | | | | | It turns out that commands was included in the toctree twice, which caused warnings which we treat as errors in CI. Fixes #994
* Merge pull request #1029 from pazz/linewisePatrick Totzke2017-02-14
|\ | | | | optional linewise focussing in thread mode
| * optional linewise focussing in thread modePatrick Totzke2017-02-09
| | | | | | | | | | | | | | | | This introduces a new config option 'thread_focus_linewise', (defaults to True), which determines if the message texts are split into individually focussable lines in thread mode. fixes #645
* | alot.rc.spec: Fix typo in documentationDylan Baker2017-02-13
|/ | | | | It currently lists "terminal_command" in relation to "editor_spawn" but the config option is actually "terminal_cmd".
* Update docs about mouse settingLucas Hoffmann2017-02-03
| | | | | There have been several people asking about text selection with the mouse setting activated so it seems reasonable to mention it here.
* Merge pull request #1000 from dcbaker/pr/argument-validatorLucas Hoffmann2017-01-27
|\ | | | | argparse validators
| * Move utils/booleanaction.py to utils/argparse.pyDylan Baker2017-01-25
| | | | | | | | | | This module is going to be enhanced with additional components in later patches in this series, so it needs a more generic name.
* | Merge pull request #1008 from dcbaker/pr/flip-mouse-bitPatrick Totzke2017-01-27
|\ \ | | | | | | Default to not handling mouse
| * | Default to not handling mouseDylan Baker2017-01-26
| |/ | | | | | | | | | | As discussed elsewhere, handling the mouse was not done before, and breaks work flows that include using the mouse for other things (middle-click paste). This only changes the default option to False.
* | Implement a hook that runs periodicallyDylan Baker2017-01-26
| | | | | | | | | | | | | | | | This creates a deferred that runs on a user configurable timer and is provided the ui. This deferred will re-fire after the number of seconds specified by the timer are eclipsed. By default this is 300 seconds. Fixes #522
* | Remove explicit mention of "body" in {pre,post}_edit_translate hook's docsLucas Hoffmann2017-01-26
| | | | | | | | | | This is done to give more emphasis to the fact that there might be header lines at the top of the string.
* | Clarify docs for {pr,post}_edit_translate hooksLucas Hoffmann2017-01-26
| |
* | Wrap long linesLucas Hoffmann2017-01-26
|/
* Merge pull request #984 from lucc/future/absolute-importsLucas Hoffmann2017-01-21
|\ | | | | Use absolute_imports from __future__
| * Use absolute_imports from __future__Lucas Hoffmann2017-01-18
| |
* | Suggest `notmuch address --format=json` in the docsLucas Hoffmann2017-01-20
| | | | | | | | | | | | | | | | The old regex that was suggested to capture addresses for completion from the command `notmuch address` was bogus. The json output format is much more predictable. Reported in #990.
* | commands/global: Don't double prompt to close last bufferDylan Baker2017-01-17
|/ | | | | | | | | | | | | Currently if global.quit_on_last_bclose is set to True (not the default), and the last buffer is an envelope, then when 'd' or ':bclose' is called, the user will be prompted twice to 'close without sending?'. This patch fixes that by skipping the prompt in BufferCloseCommand, if there is 1 buffer, and global.quit_on_last_bclose is True. It does this by adding a private keyword to the ExitCommand() constructor, telling that classes apply method to not prompt. Fixes #979
* Update synopsis.rstAtilla Mas2017-01-17
| | | Fix typo
* Add a setting for enabling or disabling mouse support.Jody Foo2017-01-13
| | | | | | | | | | Mouse support is enabled by default. To disable mouse support, set ``` handle_mouse = False ``` in your config file.
* Update synopsis in help documentsLucas Hoffmann2017-01-10
|
* docs: mock our urwidtreesPatrick Totzke2017-01-08
| | | | | | | | this is to make sure that sphinx's autodoc works for `alot.UI` and other urwid-derived classes when building the docs on readthedocs.net fixes #938
* fix odd continuation and indentationDylan Baker2016-12-27
| | | | This is just whitespace changes.
* faqPatrick Totzke2016-12-18
|
* Use cls as first argument to classmethodsLucas Hoffmann2016-12-17
|
* more pythonic names in doc-scriptsPatrick Totzke2016-12-16
| | | | https://www.quantifiedcode.com/app/issue_class/AiJMd9EB
* Update autogenerated docsLucas Hoffmann2016-12-14
|
* Update autogenerated documentation filesLucas Hoffmann2016-12-11
|
* Remove trainling whitespace when autogenerating docsLucas Hoffmann2016-12-11
|
* Add target to delete generated doc filesLucas Hoffmann2016-12-11
| | | | | | When checking out files from git the timestamps might not give enough information to make which files to remake. So this new target can be used to force a remake of all generated files on the next run.
* Fix path in docs generating scriptsLucas Hoffmann2016-12-11
| | | | | | | | | The path to the present development version of alot should be prepended to sys.path in order to shadow other versions of alot installed on the system. Also it should be a directory from which the alot module is loadable. That is the root of the git repository and not one level above this. This was overlooked in #912.
* Remove :option: marker from pip option in docsLucas Hoffmann2016-12-11
| | | | | `sphinx-build -W` was complaining as this is not a option of alot and can not be found in our documentation.
* Remove trailing white spaceLucas Hoffmann2016-12-11
|
* Use some more variables in makefileLucas Hoffmann2016-12-10
| | | | | | | | | | | | | On Arch Linux python points to python3 and hence the makefile fails. With this change users can tell the makefile which python executable to use: make PYTHON=/some/version2/python ... or simply make PYTHON=python2 ... For sake of completeness the same is done for rm.
* Fix NoneType error in docs scriptLucas Hoffmann2016-12-10
|
* docs: fix incorrect module/class namesIan Denhardt2016-12-10
| | | | | | | | api/settings.rst previously erroneously pluralized alot.addressbook, named one class that does not exist, named one from a sub module, and omitted two sub modules (with classes). This was causing build errors from sphinx
* New option `thread_authors_order_by` to control author orderTommy Lindgren2016-12-06
| | | | | | | | | | | | | Default value 'first_message' lists authors in the order they joined the conversation. Value 'latest_message' order authors by their latest message, which makes it easier to see which authors who wrote the most recent messages. Note that authors with duplicate emails were previously filtered. We now keep all authors where name + email is unique. This is behavior is desired for some email notification services. For example, Jira will set the From header to "Joe User <jira@company.com>" meaning you will only see one author if you only keep unique email addresses.
* Use `is` operator for comparing with `None` (Pep8)Cody2016-12-06
|
* Specify dependencies for generated docs.Lucas Hoffmann2016-03-24
| | | | This should save some manual deleting and regenerating of these files.
* Added UNIX Signals section to synopsis describingMicah Nordland2016-01-26
| | | | How the SIGUSR1 signal is handled