Add docs and toolbar entry

Author: joguSD

README.rst

@@ -180,7 +180,8 @@ Inline Documentation
 The aws-shell will automatically pull up documentation as you type commands.
 It will show inline documentation for CLI options.  There is also a separate
 documentation panel that will show documentation for the current command or
-option you are typing.
+option you are typing. Pressing F9 or clicking this panel will focus it
+allowing the use of your keybindings or scroll wheel to navigate the docs.
 
 .. image:: https://cloud.githubusercontent.com/assets/368057/11823320/36ae9b04-a328-11e5-9661-81abfc0afe5a.png
 
@@ -211,6 +212,7 @@ The aws-shell has a bottom toolbar that provides several options:
 * ``F3`` toggles between VI and Emacs key bindings
 * ``F4`` toggles between single and multi column auto completions
 * ``F5`` shows and hides the help documentation pane
+* ``F9`` toggles focus between the cli and documentation pane
 * ``F10`` or ``Ctrl-D`` exits the aws-shell
 
 As you toggle options in the toolbar, your preferences are persisted

awsshell/toolbar.py

@@ -54,11 +54,11 @@ def _create_toolbar_handler(self, get_match_fuzzy, get_enable_vi_bindings,
         assert callable(get_show_completion_columns)
         assert callable(get_show_help)
 
-        def get_toolbar_items(_):
+        def get_toolbar_items(cli):
             """Return the toolbar items.
 
-            :type _: :class:`prompt_toolkit.Cli`
-            :param _: (Unused)
+            :type cli: :class:`prompt_toolkit.Cli`
+            :param cli: The command line interface from prompt_toolkit
 
             :rtype: list
             :return: A list of (pygments.Token.Toolbar, str).
@@ -87,6 +87,10 @@ def get_toolbar_items(_):
             else:
                 show_help_token = Token.Toolbar.Off
                 show_help_cfg = 'OFF'
+            if cli.current_buffer_name == 'DEFAULT_BUFFER':
+                show_buffer_name = 'cli'
+            else:
+                show_buffer_name = 'doc'
             return [
                 (match_fuzzy_token,
                  ' [F2] Fuzzy: {0} '.format(match_fuzzy_cfg)),
@@ -96,6 +100,8 @@ def get_toolbar_items(_):
                  ' [F4] {0} Column '.format(show_columns_cfg)),
                 (show_help_token,
                  ' [F5] Help: {0} '.format(show_help_cfg)),
+                (Token.Toolbar,
+                 ' [F9] Focus: {0} '.format(show_buffer_name)),
                 (Token.Toolbar,
                  ' [F10] Exit ')
             ]

tests/unit/test_toolbar.py

@@ -22,6 +22,7 @@ class ToolbarTest(unittest.TestCase):
 
     def setUp(self):
         self.aws_shell = AWSShell(mock.Mock(), mock.Mock(), mock.Mock())
+        self.cli = mock.Mock()
         self.toolbar = Toolbar(
             lambda: self.aws_shell.model_completer.match_fuzzy,
             lambda: self.aws_shell.enable_vi_bindings,
@@ -38,18 +39,21 @@ def test_toolbar_on(self):
             (Token.Toolbar.On, ' [F3] Keys: Vi '),
             (Token.Toolbar.On, ' [F4] Multi Column '),
             (Token.Toolbar.On, ' [F5] Help: ON '),
+            (Token.Toolbar, ' [F9] Focus: doc '),
             (Token.Toolbar, ' [F10] Exit ')]
-        assert expected == self.toolbar.handler(None)
+        assert expected == self.toolbar.handler(self.cli)
 
     def test_toolbar_off(self):
         self.aws_shell.model_completer.match_fuzzy = False
         self.aws_shell.enable_vi_bindings = False
         self.aws_shell.show_completion_columns = False
         self.aws_shell.show_help = False
+        self.cli.current_buffer_name = 'DEFAULT_BUFFER'
         expected = [
             (Token.Toolbar.Off, ' [F2] Fuzzy: OFF '),
             (Token.Toolbar.On, ' [F3] Keys: Emacs '),
             (Token.Toolbar.On, ' [F4] Single Column '),
             (Token.Toolbar.Off, ' [F5] Help: OFF '),
+            (Token.Toolbar, ' [F9] Focus: cli '),
             (Token.Toolbar, ' [F10] Exit ')]
-        assert expected == self.toolbar.handler(None)
+        assert expected == self.toolbar.handler(self.cli)