diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2012-05-21 22:08:29 +0100 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-05-23 22:26:21 +0100 |
commit | f382daa224eb9fba297c57703375e093016f64d8 (patch) | |
tree | c3bf53a018c0d18c4f7417cab04f0d06067464a7 /docs/source/usage | |
parent | 087e1a35de70a2d92650c0f326785466667d7019 (diff) |
doc: generate_meta in default make target
This adds a new default make target that
cleans up, generates missing source files and thereafter the html docs.
it also removes the checked in generated stuff.
cf issue #456
Diffstat (limited to 'docs/source/usage')
-rw-r--r-- | docs/source/usage/modes/bufferlist.rst | 5 | ||||
-rw-r--r-- | docs/source/usage/modes/envelope.rst | 14 | ||||
-rw-r--r-- | docs/source/usage/modes/global.rst | 20 | ||||
-rw-r--r-- | docs/source/usage/modes/search.rst | 12 | ||||
-rw-r--r-- | docs/source/usage/modes/taglist.rst | 4 | ||||
-rw-r--r-- | docs/source/usage/modes/thread.rst | 19 |
6 files changed, 74 insertions, 0 deletions
diff --git a/docs/source/usage/modes/bufferlist.rst b/docs/source/usage/modes/bufferlist.rst index b619edf5..3028916e 100644 --- a/docs/source/usage/modes/bufferlist.rst +++ b/docs/source/usage/modes/bufferlist.rst @@ -1,7 +1,11 @@ +.. CAUTION: THIS FILE IS AUTO-GENERATED! + + bufferlist ---------- The following commands are available in bufferlist mode +.. _cmd_bufferlist_close: .. index:: close close @@ -10,6 +14,7 @@ _____ close focussed buffer +.. _cmd_bufferlist_select: .. index:: select select diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst index c3c7083c..be3b79f1 100644 --- a/docs/source/usage/modes/envelope.rst +++ b/docs/source/usage/modes/envelope.rst @@ -1,7 +1,11 @@ +.. CAUTION: THIS FILE IS AUTO-GENERATED! + + envelope -------- The following commands are available in envelope mode +.. _cmd_envelope_set: .. index:: set set @@ -17,6 +21,7 @@ positional arguments optional arguments :---append: keep previous values. +.. _cmd_envelope_togglesign: .. index:: togglesign togglesign @@ -28,6 +33,7 @@ argument which key id to use +.. _cmd_envelope_toggleheaders: .. index:: toggleheaders toggleheaders @@ -36,6 +42,7 @@ _____________ toggle display of all headers +.. _cmd_envelope_edit: .. index:: edit edit @@ -47,6 +54,7 @@ optional arguments :---spawn: force spawning of editor in a new terminal. :---no-refocus: don't refocus envelope after editing (Defaults to: 'True'). +.. _cmd_envelope_send: .. index:: send send @@ -55,6 +63,7 @@ ____ send mail +.. _cmd_envelope_sign: .. index:: sign sign @@ -66,6 +75,7 @@ argument which key id to use +.. _cmd_envelope_attach: .. index:: attach attach @@ -77,6 +87,7 @@ argument file(s) to attach (accepts wildcads) +.. _cmd_envelope_refine: .. index:: refine refine @@ -88,6 +99,7 @@ argument header to refine +.. _cmd_envelope_save: .. index:: save save @@ -96,6 +108,7 @@ ____ save draft +.. _cmd_envelope_unsign: .. index:: unsign unsign @@ -104,6 +117,7 @@ ______ mark mail not to be signed before sending +.. _cmd_envelope_unset: .. index:: unset unset diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst index 845db65f..58ea6383 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -1,7 +1,11 @@ +.. CAUTION: THIS FILE IS AUTO-GENERATED! + + global ------ The following commands are available globally +.. _cmd_global_bclose: .. index:: bclose bclose @@ -10,6 +14,7 @@ ______ close a buffer +.. _cmd_global_bprevious: .. index:: bprevious bprevious @@ -18,6 +23,7 @@ _________ focus previous buffer +.. _cmd_global_search: .. index:: search search @@ -31,6 +37,7 @@ argument optional arguments :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. +.. _cmd_global_compose: .. index:: compose compose @@ -49,6 +56,7 @@ optional arguments :---omit_signature: do not add signature. :---spawn: spawn editor in new terminal. +.. _cmd_global_prompt: .. index:: prompt prompt @@ -60,6 +68,7 @@ argument initial content +.. _cmd_global_help: .. index:: help help @@ -74,6 +83,7 @@ argument command or 'bindings' +.. _cmd_global_move: .. index:: move move @@ -85,6 +95,7 @@ argument direction +.. _cmd_global_shellescape: .. index:: shellescape shellescape @@ -100,6 +111,7 @@ optional arguments :---thread: run in separate thread. :---refocus: refocus current buffer after command has finished. +.. _cmd_global_refresh: .. index:: refresh refresh @@ -108,6 +120,7 @@ _______ refresh the current buffer +.. _cmd_global_cancel: .. index:: cancel cancel @@ -116,6 +129,7 @@ ______ send cancel event +.. _cmd_global_pyshell: .. index:: pyshell pyshell @@ -124,6 +138,7 @@ _______ open an interactive python shell for introspection +.. _cmd_global_exit: .. index:: exit exit @@ -132,6 +147,7 @@ ____ shut down cleanly +.. _cmd_global_flush: .. index:: flush flush @@ -140,6 +156,7 @@ _____ flush write operations or retry until committed +.. _cmd_global_bufferlist: .. index:: bufferlist bufferlist @@ -148,6 +165,7 @@ __________ open a list of active buffers +.. _cmd_global_bnext: .. index:: bnext bnext @@ -156,6 +174,7 @@ _____ focus next buffer +.. _cmd_global_select: .. index:: select select @@ -164,6 +183,7 @@ ______ send select event +.. _cmd_global_taglist: .. index:: taglist taglist diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst index 6a8632d5..16404cf4 100644 --- a/docs/source/usage/modes/search.rst +++ b/docs/source/usage/modes/search.rst @@ -1,7 +1,11 @@ +.. CAUTION: THIS FILE IS AUTO-GENERATED! + + search ------ The following commands are available in search mode +.. _cmd_search_sort: .. index:: sort sort @@ -13,6 +17,7 @@ argument sort order. valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. +.. _cmd_search_untag: .. index:: untag untag @@ -26,6 +31,7 @@ argument optional arguments :---no-flush: postpone a writeout to the index (Defaults to: 'True'). +.. _cmd_search_retag: .. index:: retag retag @@ -39,6 +45,7 @@ argument optional arguments :---no-flush: postpone a writeout to the index (Defaults to: 'True'). +.. _cmd_search_refineprompt: .. index:: refineprompt refineprompt @@ -47,6 +54,7 @@ ____________ prompt to change this buffers querystring +.. _cmd_search_tag: .. index:: tag tag @@ -60,6 +68,7 @@ argument optional arguments :---no-flush: postpone a writeout to the index (Defaults to: 'True'). +.. _cmd_search_refine: .. index:: refine refine @@ -73,6 +82,7 @@ argument optional arguments :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. +.. _cmd_search_retagprompt: .. index:: retagprompt retagprompt @@ -81,6 +91,7 @@ ___________ prompt to retag selected threads' tags +.. _cmd_search_toggletags: .. index:: toggletags toggletags @@ -98,6 +109,7 @@ argument optional arguments :---no-flush: postpone a writeout to the index (Defaults to: 'True'). +.. _cmd_search_select: .. index:: select select diff --git a/docs/source/usage/modes/taglist.rst b/docs/source/usage/modes/taglist.rst index 4272ccfa..c6f7198b 100644 --- a/docs/source/usage/modes/taglist.rst +++ b/docs/source/usage/modes/taglist.rst @@ -1,7 +1,11 @@ +.. CAUTION: THIS FILE IS AUTO-GENERATED! + + taglist ------- The following commands are available in taglist mode +.. _cmd_taglist_select: .. index:: select select diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst index 781e3602..096d7c20 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -1,7 +1,11 @@ +.. CAUTION: THIS FILE IS AUTO-GENERATED! + + thread ------ The following commands are available in thread mode +.. _cmd_thread_pipeto: .. index:: pipeto pipeto @@ -21,6 +25,7 @@ optional arguments :---shell: let the shell interpret the command. :---notify_stdout: display command's stdout as notification message. +.. _cmd_thread_editnew: .. index:: editnew editnew @@ -31,6 +36,7 @@ edit message in as new optional arguments :---spawn: open editor in new window. +.. _cmd_thread_toggleheaders: .. index:: toggleheaders toggleheaders @@ -41,6 +47,7 @@ display all headers optional arguments :---all: affect all messages. +.. _cmd_thread_print: .. index:: print print @@ -54,6 +61,7 @@ optional arguments :---separately: call print command once for each message. :---add_tags: add 'Tags' header to the message. +.. _cmd_thread_remove: .. index:: remove remove @@ -64,6 +72,7 @@ remove message(s) from the index optional arguments :---all: remove whole thread. +.. _cmd_thread_togglesource: .. index:: togglesource togglesource @@ -74,6 +83,7 @@ display message source optional arguments :---all: affect all messages. +.. _cmd_thread_retag: .. index:: retag retag @@ -88,6 +98,7 @@ optional arguments :---all: tag all messages in thread. :---no-flush: postpone a writeout to the index (Defaults to: 'True'). +.. _cmd_thread_fold: .. index:: fold fold @@ -98,6 +109,7 @@ fold message(s) optional arguments :---all: fold all messages. +.. _cmd_thread_tag: .. index:: tag tag @@ -112,6 +124,7 @@ optional arguments :---all: tag all messages in thread. :---no-flush: postpone a writeout to the index (Defaults to: 'True'). +.. _cmd_thread_untag: .. index:: untag untag @@ -126,6 +139,7 @@ optional arguments :---all: tag all messages in thread. :---no-flush: postpone a writeout to the index (Defaults to: 'True'). +.. _cmd_thread_unfold: .. index:: unfold unfold @@ -136,6 +150,7 @@ unfold message(s) optional arguments :---all: unfold all messages. +.. _cmd_thread_forward: .. index:: forward forward @@ -147,6 +162,7 @@ optional arguments :---attach: attach original mail. :---spawn: open editor in new window. +.. _cmd_thread_reply: .. index:: reply reply @@ -158,6 +174,7 @@ optional arguments :---all: reply to all. :---spawn: open editor in new window. +.. _cmd_thread_save: .. index:: save save @@ -171,6 +188,7 @@ argument optional arguments :---all: save all attachments. +.. _cmd_thread_toggletags: .. index:: toggletags toggletags @@ -185,6 +203,7 @@ optional arguments :---all: tag all messages in thread. :---no-flush: postpone a writeout to the index (Defaults to: 'True'). +.. _cmd_thread_select: .. index:: select select |