.. ska_shell documentation master file, created by
   sphinx-quickstart on Thu May 23 10:58:30 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to ska_shell's documentation!
=====================================

.. automodule:: ska_shell

Functions
----------

.. autofunction:: bash

.. autofunction:: bash_shell

.. autofunction:: getenv

.. autofunction:: importenv

.. autofunction:: run_shell

.. autofunction:: tcsh

.. autofunction:: tcsh_shell


Classes
--------

.. autoclass:: Spawn
   :show-inheritance:
   :members:
   :inherited-members:
   :undoc-members:


Exceptions
------------

.. autoclass:: RunTimeoutError
   :show-inheritance:
   :members:
   :inherited-members:
   :undoc-members:


.. autoclass:: ShellError
   :show-inheritance:
   :members:
   :inherited-members:
   :undoc-members: