summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-07-25 07:51:47 +0100
committerPatrick Totzke <patricktotzke@gmail.com>2012-07-25 07:51:47 +0100
commit9f308a2901d1003e883fdeecc9d2af0489e5379f (patch)
tree149f6eecefa80d00bcbdae1b7d4c194a9a4cd0f8 /docs
parent3125495f01e635465143497b1967998318f32af9 (diff)
doc: section names for commands sections
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/source/generate_commands.py5
-rw-r--r--docs/source/usage/commands12
-rw-r--r--docs/source/usage/modes/bufferlist.rst4
-rw-r--r--docs/source/usage/modes/envelope.rst4
-rw-r--r--docs/source/usage/modes/global.rst4
-rw-r--r--docs/source/usage/modes/search.rst4
-rw-r--r--docs/source/usage/modes/taglist.rst4
-rw-r--r--docs/source/usage/modes/thread.rst4
8 files changed, 22 insertions, 19 deletions
diff --git a/docs/source/generate_commands.py b/docs/source/generate_commands.py
index b7a175de..3731c574 100755
--- a/docs/source/generate_commands.py
+++ b/docs/source/generate_commands.py
@@ -112,11 +112,14 @@ if __name__ == "__main__":
modefilename = mode+'.rst'
modefile = open(os.path.join(HERE, 'usage', 'modes', modefilename), 'w')
modefile.write(NOTE)
- modefile.write('%s\n%s\n' % (mode, '-' * len(mode)))
if mode != 'global':
modes.append(mode)
+ header = 'Commands in `%s` mode' % mode
+ modefile.write('%s\n%s\n' % (header, '-' * len(header)))
modefile.write('The following commands are available in %s mode\n\n' % mode)
else:
+ header = 'Global Commands'
+ modefile.write('%s\n%s\n' % (header, '-' * len(header)))
modefile.write('The following commands are available globally\n\n')
for cmdstring,struct in modecommands.items():
cls, parser, forced_args = struct
diff --git a/docs/source/usage/commands b/docs/source/usage/commands
index ec0be2eb..daf36a1d 100644
--- a/docs/source/usage/commands
+++ b/docs/source/usage/commands
@@ -3,17 +3,17 @@
Commands
========
-:doc:`modes/global`
+:doc:`global <modes/global>`
globally available commands
-:doc:`modes/search`
+:doc:`search <modes/search>`
shows a result list of threads for a query
-:doc:`modes/thread`
+:doc:`thread <modes/thread>`
displays a thread as a tree of messages
-:doc:`modes/envelope`
+:doc:`envelope <modes/envelope>`
message composition mode
-:doc:`modes/bufferlist`
+:doc:`bufferlist <modes/bufferlist>`
lists all active buffers
-:doc:`modes/taglist`
+:doc:`taglist <modes/taglist>`
lists all tagstrings present in the notmuch database
.. toctree::
diff --git a/docs/source/usage/modes/bufferlist.rst b/docs/source/usage/modes/bufferlist.rst
index dc2d4dfc..79ec2e34 100644
--- a/docs/source/usage/modes/bufferlist.rst
+++ b/docs/source/usage/modes/bufferlist.rst
@@ -1,8 +1,8 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-bufferlist
-----------
+Commands in `bufferlist` mode
+-----------------------------
The following commands are available in bufferlist mode
.. _cmd.bufferlist.close:
diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst
index 65b39c6a..b3f478be 100644
--- a/docs/source/usage/modes/envelope.rst
+++ b/docs/source/usage/modes/envelope.rst
@@ -1,8 +1,8 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-envelope
---------
+Commands in `envelope` mode
+---------------------------
The following commands are available in envelope mode
.. _cmd.envelope.set:
diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst
index 9b8f5307..ce105f2f 100644
--- a/docs/source/usage/modes/global.rst
+++ b/docs/source/usage/modes/global.rst
@@ -1,8 +1,8 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-global
-------
+Global Commands
+---------------
The following commands are available globally
.. _cmd.global.bclose:
diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst
index 73b158c2..5347e44d 100644
--- a/docs/source/usage/modes/search.rst
+++ b/docs/source/usage/modes/search.rst
@@ -1,8 +1,8 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-search
-------
+Commands in `search` mode
+-------------------------
The following commands are available in search mode
.. _cmd.search.sort:
diff --git a/docs/source/usage/modes/taglist.rst b/docs/source/usage/modes/taglist.rst
index 995e75e5..a22f7c2e 100644
--- a/docs/source/usage/modes/taglist.rst
+++ b/docs/source/usage/modes/taglist.rst
@@ -1,8 +1,8 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-taglist
--------
+Commands in `taglist` mode
+--------------------------
The following commands are available in taglist mode
.. _cmd.taglist.select:
diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst
index b60215d7..40e475cc 100644
--- a/docs/source/usage/modes/thread.rst
+++ b/docs/source/usage/modes/thread.rst
@@ -1,8 +1,8 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-thread
-------
+Commands in `thread` mode
+-------------------------
The following commands are available in thread mode
.. _cmd.thread.pipeto: