fix documentation and sphinx setup

docs-requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinxcontrib-fulltoc
+-r requirements.txt

docs/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/employ.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/employ.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/employ"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/employ"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/commands.ab.rst

@@ -0,0 +1,5 @@
+employ.commands.ab
+==================
+
+.. automodule:: employ.commands.ab
+  :members:

docs/commands.rst

@@ -0,0 +1,5 @@
+employ.commands
+==================
+
+.. automodule:: employ.commands
+  :members:

docs/conf.py

@@ -0,0 +1,254 @@
+# -*- coding: utf-8 -*-
+#
+# Employ documentation build configuration file, created by
+# sphinx-quickstart on Mon Sep  9 23:13:30 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+root_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+sys.path.insert(0, root_path)
+
+import employ
+
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinxcontrib.fulltoc', 'sphinx.ext.viewcode']
+
+autoclass_content = 'both'
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'employ'
+copyright = u'2013, Brett Langdon'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = employ.__version__
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'employdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'employ.tex', u'Employ Documentation',
+   u'Brett Langdon', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'employ', u'Employ Documentation',
+     [u'Brett Langdon'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'employ', u'Employ Documentation',
+   u'Brett Langdon', 'Employ', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False

docs/employ.rst

@@ -0,0 +1,5 @@
+employ
+======
+
+.. automodule:: employ
+  :members:

docs/exceptions.rst

@@ -0,0 +1,5 @@
+employ.exceptions
+=====================
+
+.. automodule:: employ.exceptions
+  :members:

docs/index.rst

@@ -0,0 +1,21 @@
+Employ documentation
+========================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   employ
+   commands
+   commands.ab
+   exceptions
+   managers
+   managers.ec2
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/managers.ec2.rst

@@ -0,0 +1,5 @@
+employ.managers.ec2
+===================
+
+.. automodule:: employ.managers.ec2
+  :members:

docs/managers.rst

@@ -0,0 +1,5 @@
+employ.managers
+================
+
+.. automodule:: employ.managers
+  :members:

employ/__init__.py

@@ -9,6 +9,11 @@ managers = load("employ.managers", subclasses=Manager)
 
 
 def available_commands():
+    """
+    Helper function to get all availabl commands.
+
+    :returns: dict - {Command.name: :class:`employ.commands.Command`}
+    """
     all_commands = {}
     for command_cls in commands:
         if command_cls.name == "command":
@@ -18,6 +23,11 @@ def available_commands():
 
 
 def available_managers():
+    """
+    Helper function to get all available managers.
+
+    :returns: dict - {Manager.name: :class:`employ.managers.Manager`}
+    """
     all_managers = {}
     for manager_cls in managers:
         if manager_cls.name == "manager":

employ/commands/__init__.py

@@ -10,12 +10,12 @@ class Command(object):
 
     def aggregate(self, results):
         """
-        Method to join together the results of running :func:``command``
+        Method to join together the results of running :func:`command`
 
         Method which must be overridden by child class.
 
         :param results: list of (status, stdout, stderr) for each
-            result of running :func:``command``
+            result of running :func:`command`
         :type results: list
         """
         raise NotImplementedError()
@@ -33,12 +33,12 @@ class Command(object):
     @classmethod
     def from_config(cls, config):
         """
-        Helper classmethod to create an instance of :class:``employ.commands.Command``
+        Helper classmethod to create an instance of :class:`employ.commands.Command`
         from the provided config.
 
-        :param config: the config to get the :class:``employ.commands.Command`` instance
-        :type config: :class:``ConfigParser.RawConfigParser``
-        ::returns: :class:``employ.commands.Command``
+        :param config: the config to get the :class:`employ.commands.Command` instance
+        :type config: :class:`ConfigParser.RawConfigParser`
+        :returns: :class:`employ.commands.Command`
         """
         settings = {}
         if config.has_section(cls.name):

employ/commands/ab.py

@@ -5,16 +5,18 @@ from employ.commands import Command
 
 class ABCommand(Command):
     """
-    :class:``employ.commands.Command`` used to run ApacheBench (ab)
+    :class:`employ.commands.Command` used to run ApacheBench (ab)
+
+    Command Settings::
 
-    Command Settings:
       [ab]
       target=<target>
       requests=<requests>
       concurrency=<concurrency>
       keepalive=(True|False)
 
-    Eample:
+    Example::
+
       ; run_ab.ini
       [ab]
       target=http://127.0.0.1:8000/test.html
@@ -22,7 +24,10 @@ class ABCommand(Command):
       concurrency=100
       keepalive=False
 
+    Running::
+
       employ <manager> run run_ab.ini
+
     """
     name = "ab"
 
@@ -89,7 +94,7 @@ class ABCommand(Command):
         The aggregate the results of multiple executions of `ab`
 
         :param results: list of (status, stdout, stderr) from the
-            results of running :func:``command``
+            results of running :func:`command`
         :type results: list
         """
         total_completed = 0

employ/managers/__init__.py

@@ -13,12 +13,12 @@ class Manager(object):
     @classmethod
     def from_config(cls, config):
         """
-        Helper classmethod used to create an instance of :class:``employ.managers.Manager``
+        Helper classmethod used to create an instance of :class:`employ.managers.Manager`
         from the provided `config`
 
         :param config: the config to get the settings from
-        :type config: :class:``ConfigParser.RawConfigParser``
-        :returns: :class:``employ.managers.Manager``
+        :type config: :class:`ConfigParser.RawConfigParser`
+        :returns: :class:`employ.managers.Manager`
         """
         settings = {}
         if config.has_section(cls.name):
@@ -38,7 +38,7 @@ class Manager(object):
 
     def __enter__(self):
         """
-        Used to call :func:``setup_instances`` when using in a context manager
+        Used to call :func:`setup_instances` when using in a context manager
 
         with manager:
             # instances are connected to
@@ -58,7 +58,7 @@ class Manager(object):
 
     def __exit__(self, type, value, traceback):
         """
-        Used to call :func:``cleanup_instances`` when using in a context manager
+        Used to call :func:`cleanup_instances` when using in a context manager
 
         with manager:
             # instances are available
@@ -86,11 +86,12 @@ class Manager(object):
         This method should execute `command.commad()` on all instances
         as well as sending the results of all instances to `command.aggregate`
 
-        The results will be in the following format:
+        The results will be in the following format::
+
             [(status, stdout, stderr), ...]
 
         :param command: the command to run on the instances
-        :type command: :class:``employ.commands.Command`
+        :type command: :class:`employ.commands.Command`
         """
         raise NotImplementedError()
 
@@ -102,7 +103,7 @@ class Manager(object):
         :type results: list
         :param command: the raw str command that was run
         :type command: str
-        :raises: :class:``employ.exections.ExecutionError``
+        :raises: :class:`employ.exections.ExecutionError`
         """
         for status, stdout, stderr in results:
             if status != 0:

employ/managers/ec2.py

@@ -15,7 +15,8 @@ class EC2Manager(Manager):
     """
     Employ Manager which creates instances in EC2
 
-    Config Parameters:
+    Config Parameters::
+
       [ec2]
       ami_image_id = ami-da0cf8b3
       num_instances = 1
@@ -36,6 +37,7 @@ class EC2Manager(Manager):
       ; when attempting to gain an ssh connection, fail after
       ; connection_attempts attempts
       connection_attempts = 10
+
     """
     name = "ec2"
 
@@ -48,7 +50,7 @@ class EC2Manager(Manager):
             wait_interval=5, connection_attempts=10
     ):
         """
-        Construct for :class:``employ.managers.EC2Manager``
+        Construct for :class:`employ.managers.EC2Manager`
 
         :param ami_image_id: the ec2 ami image to use
         :type ami_image_id: str
@@ -72,20 +74,28 @@ class EC2Manager(Manager):
         self.connection_attempts = connection_attempts
         self._connection = None
 
-    @classmethod
-    def available_regions(cls):
-        for region in boto.ec2.regions():
-            yield region.name
-
     def connection(self):
+        """
+        Returns a boto connection.
+
+        :returns: :class:`boto.ec2.connection.EC2Connection`
+        """
         if not self._connection:
             self._connection = boto.ec2.connect_to_region(self.region)
         return self._connection
 
     def instance_ids(self):
+        """
+        Get list of client instance ids
+
+        :returns: list
+        """
         return [instance.id for instance in self.instances]
 
     def setup_instances(self):
+        """
+        Starts `self.num_instances` new EC2 instances and establish SSH connections to each
+        """
         logger.info("starting %s instances", self.num_instances)
         connection = self.connection()
         reservation = connection.run_instances(
@@ -132,6 +142,9 @@ class EC2Manager(Manager):
                 )
 
     def cleanup_instances(self):
+        """
+        Close all open SSH connections and terminate all instances.
+        """
         for client in self.client_connections:
             client.close()
 
@@ -139,6 +152,14 @@ class EC2Manager(Manager):
         connection.terminate_instances(instance_ids=self.instance_ids())
 
     def setup(self, script):
+        """
+        Run setup `script` on all instances.
+
+        Upload `script` to each instance and execute.
+
+        :param script: the filename of the script to upload and run
+        :type script: str
+        """
         remote_file = "/tmp/%s" % basename(script)
         workers = []
         for client in self.client_connections:
@@ -154,12 +175,18 @@ class EC2Manager(Manager):
         self.validate_results(results, command)
 
     def run(self, command):
+        """
+        Run :class:`employ.commands.Command` `command` on all instances.
+        """
         execute = command.command()
         results = self._run_multi(execute)
         self.validate_results(results, execute)
         command.aggregate(results)
 
     def _run_command(self, client, command, results):
+        """
+        Helper method for executing a single command on a client
+        """
         transport = client.get_transport()
         channel = transport.open_session()
         logger.info("executing command %s", command)
@@ -175,6 +202,9 @@ class EC2Manager(Manager):
         results.put((status, stdout, stderr))
 
     def _run_multi(self, command):
+        """
+        Helper method for executing a command across all instances
+        """
         results = Queue()
         workers = []
         for client in self.client_connections:
@@ -192,6 +222,9 @@ class EC2Manager(Manager):
         return all_results
 
     def _put_file(self, client, script, remote_file):
+        """
+        Helper method to upload a file to an instance
+        """
         fp = open(script, "r")
         transport = client.get_transport()
         sftp_client = paramiko.SFTPClient.from_transport(transport)