Updated docs.

docs/build/html/README.html

@@ -117,6 +117,7 @@ <h3>Features<a class="headerlink" href="#features" title="Permalink to this head
 <li><a class="reference external" href="#customizable-shortcuts">Customizable Shortcuts</a></li>
 <li><a class="reference external" href="#fuzzy-resource-and-shortcut-completion">Fuzzy Resource and Shortcut
 Completion</a></li>
+<li><a class="reference external" href="#executing-shell-commands">Executing Shell Commands</a></li>
 <li><a class="reference external" href="#contextual-help">Contextual Help</a><ul>
 <li><a class="reference external" href="#contextual-command-line-help">Contextual Command Line Help</a></li>
 <li><a class="reference external" href="#contextual-web-docs">Contextual Web Docs</a></li>
@@ -161,7 +162,9 @@ <h2>Syntax and Output Highlighting<a class="headerlink" href="#syntax-and-output
 <img alt="" src="http://i.imgur.com/xQDpw70.png" />
 </div>
 <p>You can control which theme to load for syntax highlighting by updating
-your <code class="docutils literal"><span class="pre">~/.sawsrc</span></code> file:</p>
+your
+<a class="reference external" href="https://github.com/donnemartin/saws/blob/master/saws/sawsrc">~/.sawsrc</a>
+file:</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="c"># Visual theme. Possible values: manni, igor, xcode, vim, autumn, vs, rrt,</span>
 <span class="c"># native, perldoc, borland, tango, emacs, friendly, monokai, paraiso-dark,</span>
 <span class="c"># colorful, murphy, bw, pastie, paraiso-light, trac, default, fruity</span>
@@ -250,13 +253,15 @@ <h3>EC2 Instance Tags<a class="headerlink" href="#ec2-instance-tags" title="Perm
 </div>
 <div class="section" id="todo-add-more-resources">
 <h3>TODO: Add More Resources<a class="headerlink" href="#todo-add-more-resources" title="Permalink to this headline">¶</a></h3>
-<p>Feel free to submit an issue or a pull request if you&#8217;d like support for
-additional resources.</p>
+<p>Feel free to <a class="reference external" href="#contributions">submit an issue or a pull request</a> if
+you&#8217;d like support for additional resources.</p>
 </div>
 <div class="section" id="configuring-resource-completion">
 <h3>Configuring Resource Completion<a class="headerlink" href="#configuring-resource-completion" title="Permalink to this headline">¶</a></h3>
 <p>You can control which resources are loaded on startup and are available
-for interactive completion by updating your <code class="docutils literal"><span class="pre">~/.sawsrc</span></code> file:</p>
+for interactive completion by updating your
+<a class="reference external" href="https://github.com/donnemartin/saws/blob/master/saws/sawsrc">~/.sawsrc</a>
+file:</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="c"># AWS resources to refresh</span>
 <span class="n">refresh_instance_ids</span> <span class="o">=</span> <span class="bp">True</span>
 <span class="n">refresh_instance_tags</span> <span class="o">=</span> <span class="bp">True</span>
@@ -269,8 +274,10 @@ <h3>Configuring Resource Completion<a class="headerlink" href="#configuring-reso
 </div>
 <div class="section" id="customizable-shortcuts">
 <h2>Customizable Shortcuts<a class="headerlink" href="#customizable-shortcuts" title="Permalink to this headline">¶</a></h2>
-<p>The <code class="docutils literal"><span class="pre">~/.sawsrc</span></code> file contains shortcuts that you can modify. It comes
-pre-populated with several <a class="reference external" href="https://github.com/donnemartin/saws/blob/master/saws/sawsrc">handy
+<p>The
+<a class="reference external" href="https://github.com/donnemartin/saws/blob/master/saws/sawsrc">~/.sawsrc</a>
+file contains shortcuts that you can modify. It comes pre-populated with
+several <a class="reference external" href="https://github.com/donnemartin/saws/blob/master/saws/sawsrc">handy
 shortcuts</a>
 out of the box. You can combine shortcuts with <a class="reference external" href="#fuzzy-resource-and-shortcut-completion">fuzzy
 completion</a> for even less
@@ -309,8 +316,9 @@ <h2>Customizable Shortcuts<a class="headerlink" href="#customizable-shortcuts" t
 <div class="highlight-python"><div class="highlight"><pre>aws emr ls  # fuzzy shortcut: aws emls
 </pre></div>
 </div>
-<p>Add/remove/modify shortcuts in your <code class="docutils literal"><span class="pre">~/.sawsrc</span></code> file to suit your
-needs.</p>
+<p>Add/remove/modify shortcuts in your
+<a class="reference external" href="https://github.com/donnemartin/saws/blob/master/saws/sawsrc">~/.sawsrc</a>
+file to suit your needs.</p>
 <p>Feel free to submit:</p>
 <ul class="simple">
 <li>An issue to request additional shortcuts</li>
@@ -333,6 +341,13 @@ <h3>Fuzzy Resource and Shortcut Completion<a class="headerlink" href="#fuzzy-res
 <img alt="" src="http://i.imgur.com/7OvFHCw.png" />
 </div>
 </div>
+<div class="section" id="executing-shell-commands">
+<h3>Executing Shell Commands<a class="headerlink" href="#executing-shell-commands" title="Permalink to this headline">¶</a></h3>
+<p><code class="docutils literal"><span class="pre">SAWS</span></code> allows you to execute shell commands from the <code class="docutils literal"><span class="pre">saws&gt;</span></code> prompt.</p>
+<div class="figure">
+<img alt="" src="http://i.imgur.com/eWW8RUH.png" />
+</div>
+</div>
 </div>
 <div class="section" id="contextual-help">
 <h2>Contextual Help<a class="headerlink" href="#contextual-help" title="Permalink to this headline">¶</a></h2>
@@ -389,8 +404,9 @@ <h2>Toolbar Options<a class="headerlink" href="#toolbar-options" title="Permalin
 <h3>Windows Support<a class="headerlink" href="#windows-support" title="Permalink to this headline">¶</a></h3>
 <p><code class="docutils literal"><span class="pre">SAWS</span></code> is developed under Mac OS X Yosemite and Ubuntu 14.04 LTS and
 has been tested on Windows 7 and Windows 10.</p>
-<p>On Windows, the <code class="docutils literal"><span class="pre">.sawsrc</span></code> file can be found in <code class="docutils literal"><span class="pre">%userprofile%</span></code>. For
-example:</p>
+<p>On Windows, the
+<a class="reference external" href="https://github.com/donnemartin/saws/blob/master/saws/sawsrc">.sawsrc</a>
+file can be found in <code class="docutils literal"><span class="pre">%userprofile%</span></code>. For example:</p>
 <div class="highlight-python"><div class="highlight"><pre>C:\Users\dmartin\.sawsrc
 </pre></div>
 </div>
@@ -414,10 +430,31 @@ <h3>Pip Installation<a class="headerlink" href="#pip-installation" title="Permal
 <div class="highlight-python"><div class="highlight"><pre>$ pip install saws
 </pre></div>
 </div>
+<p>I highly recommend installing Python packages in a
+<a class="reference external" href="http://docs.python-guide.org/en/latest/dev/virtualenvs/">virtualenv</a>
+to avoid any <a class="reference external" href="https://github.com/donnemartin/saws/issues/15">issues with dependencies or
+permissions</a>.</p>
 <p>Once installed, run the following command to start <code class="docutils literal"><span class="pre">SAWS</span></code>:</p>
 <div class="highlight-python"><div class="highlight"><pre>$ saws
 </pre></div>
 </div>
+<p>If you&#8217;d like to use a specific named profile with <code class="docutils literal"><span class="pre">SAWS</span></code>, run the
+following commands on OS X, Linux, or Unix:</p>
+<div class="highlight-python"><div class="highlight"><pre>$ export AWS_DEFAULT_PROFILE=user1
+$ saws
+</pre></div>
+</div>
+<p>Or as a one-liner:</p>
+<div class="highlight-python"><div class="highlight"><pre>$ AWS_DEFAULT_PROFILE=user1 saws
+</pre></div>
+</div>
+<p>Windows users can run the following commands:</p>
+<div class="highlight-python"><div class="highlight"><pre>&gt; set AWS_DEFAULT_PROFILE=user1
+&gt; saws
+</pre></div>
+</div>
+<p>Command line options for starting <code class="docutils literal"><span class="pre">SAWS</span></code> with a specific profile are
+<a class="reference external" href="https://github.com/donnemartin/saws/issues/16">under development</a>.</p>
 </div>
 <div class="section" id="configuring-aws-credentials">
 <h3>Configuring AWS Credentials<a class="headerlink" href="#configuring-aws-credentials" title="Permalink to this headline">¶</a></h3>
@@ -447,15 +484,15 @@ <h3>Supported Python Versions<a class="headerlink" href="#supported-python-versi
 <div class="section" id="supported-platforms">
 <h3>Supported Platforms<a class="headerlink" href="#supported-platforms" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li>Mac OS X</li>
+<li>Mac OS X (Tested on OS X 10.10)</li>
 <li>*nix (Tested on Ubuntu 14.04 LTS)</li>
-<li>Windows 7</li>
-<li>Windows 10</li>
+<li>Windows (Tested on Windows 7 and 10)</li>
 </ul>
 </div>
 </div>
 <div class="section" id="developer-installation">
 <h2>Developer Installation<a class="headerlink" href="#developer-installation" title="Permalink to this headline">¶</a></h2>
+<p>If you&#8217;re interested in contributing to <code class="docutils literal"><span class="pre">SAWS</span></code>, run the following:</p>
 <div class="highlight-python"><div class="highlight"><pre>$ git clone https://github.com/donnemartin/saws.git
 $ pip install -e .
 $ pip install -r requirements-dev.txt
@@ -494,11 +531,10 @@ <h3>Unit Tests and Code Coverage<a class="headerlink" href="#unit-tests-and-code
 <div class="section" id="documentation">
 <h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h3>
 <p><a class="reference external" href="http://saws.readthedocs.org/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/saws/badge/?version=latest" /></a></p>
-<p>Documentation is available on
+<p>Source code documentation is available on
 <a class="reference external" href="http://saws.readthedocs.org/en/latest/?badge=latest">Readthedocs.org</a>.</p>
 <p>Run the following to build the docs:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ cd docs
-$ make html
+<div class="highlight-python"><div class="highlight"><pre>$ scripts/update_docs.sh
 </pre></div>
 </div>
 </div>
@@ -591,6 +627,7 @@ <h3><a href="index.html">Table Of Contents</a></h3>
 </li>
 <li><a class="reference internal" href="#customizable-shortcuts">Customizable Shortcuts</a><ul>
 <li><a class="reference internal" href="#fuzzy-resource-and-shortcut-completion">Fuzzy Resource and Shortcut Completion</a></li>
+<li><a class="reference internal" href="#executing-shell-commands">Executing Shell Commands</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#contextual-help">Contextual Help</a><ul>

docs/build/html/_sources/README.txt

@@ -87,6 +87,7 @@ Features
 -  `Customizable Shortcuts <#customizable-shortcuts>`__
 -  `Fuzzy Resource and Shortcut
    Completion <#fuzzy-resource-and-shortcut-completion>`__
+-  `Executing Shell Commands <#executing-shell-commands>`__
 -  `Contextual Help <#contextual-help>`__
 
    -  `Contextual Command Line Help <#contextual-command-line-help>`__
@@ -127,7 +128,9 @@ Syntax and Output Highlighting
    :alt: 
 
 You can control which theme to load for syntax highlighting by updating
-your ``~/.sawsrc`` file:
+your
+`~/.sawsrc <https://github.com/donnemartin/saws/blob/master/saws/sawsrc>`__
+file:
 
 ::
 
@@ -242,14 +245,16 @@ use of `customizable shortcuts <#customizable-shortcuts>`__:
 TODO: Add More Resources
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-Feel free to submit an issue or a pull request if you'd like support for
-additional resources.
+Feel free to `submit an issue or a pull request <#contributions>`__ if
+you'd like support for additional resources.
 
 Configuring Resource Completion
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can control which resources are loaded on startup and are available
-for interactive completion by updating your ``~/.sawsrc`` file:
+for interactive completion by updating your
+`~/.sawsrc <https://github.com/donnemartin/saws/blob/master/saws/sawsrc>`__
+file:
 
 ::
 
@@ -264,8 +269,10 @@ loading. To refresh the cache, use the ``F5`` key.
 Customizable Shortcuts
 ----------------------
 
-The ``~/.sawsrc`` file contains shortcuts that you can modify. It comes
-pre-populated with several `handy
+The
+`~/.sawsrc <https://github.com/donnemartin/saws/blob/master/saws/sawsrc>`__
+file contains shortcuts that you can modify. It comes pre-populated with
+several `handy
 shortcuts <https://github.com/donnemartin/saws/blob/master/saws/sawsrc>`__
 out of the box. You can combine shortcuts with `fuzzy
 completion <#fuzzy-resource-and-shortcut-completion>`__ for even less
@@ -317,8 +324,9 @@ List all EMR clusters:
 
     aws emr ls  # fuzzy shortcut: aws emls
 
-Add/remove/modify shortcuts in your ``~/.sawsrc`` file to suit your
-needs.
+Add/remove/modify shortcuts in your
+`~/.sawsrc <https://github.com/donnemartin/saws/blob/master/saws/sawsrc>`__
+file to suit your needs.
 
 Feel free to submit:
 
@@ -346,6 +354,14 @@ Note: Fuzzy completion currently only works with AWS
 .. figure:: http://i.imgur.com/7OvFHCw.png
    :alt: 
 
+Executing Shell Commands
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+``SAWS`` allows you to execute shell commands from the ``saws>`` prompt.
+
+.. figure:: http://i.imgur.com/eWW8RUH.png
+   :alt: 
+
 Contextual Help
 ---------------
 
@@ -412,8 +428,9 @@ Windows Support
 ``SAWS`` is developed under Mac OS X Yosemite and Ubuntu 14.04 LTS and
 has been tested on Windows 7 and Windows 10.
 
-On Windows, the ``.sawsrc`` file can be found in ``%userprofile%``. For
-example:
+On Windows, the
+`.sawsrc <https://github.com/donnemartin/saws/blob/master/saws/sawsrc>`__
+file can be found in ``%userprofile%``. For example:
 
 ::
 
@@ -443,12 +460,41 @@ the `AWS CLI <https://github.com/aws/aws-cli>`__:
 
     $ pip install saws
 
+I highly recommend installing Python packages in a
+`virtualenv <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`__
+to avoid any `issues with dependencies or
+permissions <https://github.com/donnemartin/saws/issues/15>`__.
+
 Once installed, run the following command to start ``SAWS``:
 
 ::
 
     $ saws
 
+If you'd like to use a specific named profile with ``SAWS``, run the
+following commands on OS X, Linux, or Unix:
+
+::
+
+    $ export AWS_DEFAULT_PROFILE=user1
+    $ saws
+
+Or as a one-liner:
+
+::
+
+    $ AWS_DEFAULT_PROFILE=user1 saws
+
+Windows users can run the following commands:
+
+::
+
+    > set AWS_DEFAULT_PROFILE=user1
+    > saws
+
+Command line options for starting ``SAWS`` with a specific profile are
+`under development <https://github.com/donnemartin/saws/issues/16>`__.
+
 Configuring AWS Credentials
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -480,14 +526,15 @@ support <https://github.com/boto/botocore/issues/622>`__ from
 Supported Platforms
 ~~~~~~~~~~~~~~~~~~~
 
--  Mac OS X
+-  Mac OS X (Tested on OS X 10.10)
 -  \*nix (Tested on Ubuntu 14.04 LTS)
--  Windows 7
--  Windows 10
+-  Windows (Tested on Windows 7 and 10)
 
 Developer Installation
 ----------------------
 
+If you're interested in contributing to ``SAWS``, run the following:
+
 ::
 
     $ git clone https://github.com/donnemartin/saws.git
@@ -539,15 +586,14 @@ Documentation
 
 |Documentation Status|
 
-Documentation is available on
+Source code documentation is available on
 `Readthedocs.org <http://saws.readthedocs.org/en/latest/?badge=latest>`__.
 
 Run the following to build the docs:
 
 ::
 
-    $ cd docs
-    $ make html
+    $ scripts/update_docs.sh
 
 Contributing
 ------------