Fixed #174 -- updated Sphinx docs to match refactored modules.

Author: mboersma

api/utils.py

@@ -61,5 +61,5 @@ def generate_app_name():
         'yachting', 'yardbird', 'yearbook', 'yearling', 'yeomanry', 'yodeling',
         'zaniness', 'zeppelin', 'ziggurat', 'zirconia', 'zoologer', 'zucchini',
     ]
-    return '{}-{}'.format(
+    return "{}-{}".format(
         random.choice(adjectives), random.choice(nouns))

cm/chef.py

@@ -44,8 +44,13 @@
     _valid_pem_path = os.path.join(CHEF_CONFIG_PATH, 'validation.pem')
     CHEF_VALIDATION_KEY = subprocess.check_output(
         ['sudo', '/bin/cat', _valid_pem_path]).strip('\n')
-except Exception as e:
-    raise EnvironmentError('Failed to auto-configure Chef -- {}'.format(e))
+except Exception as err:
+    msg = "Failed to auto-configure Chef -- {}".format(err)
+    if os.environ.get('READTHEDOCS'):
+        # Just print the error if Sphinx is running
+        print(msg)
+    else:
+        raise EnvironmentError(msg)
 
 
 def _get_client():

cm/views.py

@@ -22,7 +22,7 @@ docopt==0.6.1
 requests==1.2.3
 
 # Deis documentation requirements
-Sphinx>=1.2b1
+Sphinx>=1.2b2
 smartypants>=1.8.2
 sphinxcontrib-httpdomain>=1.1.9
 

dev_requirements.txt

@@ -9,6 +9,9 @@ PYTHON        = python
 ZIP           = zip
 BUILDDIR      = _build
 
+READTHEDOCS   = true
+export READTHEDOCS
+
 # 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/)

docs/Makefile

@@ -0,0 +1,14 @@
+:description: Python API Reference for the Deis api.ssh module
+:keywords: deis, api.ssh, python, api
+
+=======
+api.ssh
+=======
+
+.. contents::
+    :local:
+.. currentmodule:: api.ssh
+
+.. automodule:: api.ssh
+    :members:
+    :undoc-members:

docs/server/api.ssh.rst

@@ -0,0 +1,27 @@
+:description: Python API Reference for the Deis api.tasks module
+:keywords: deis, api.tasks, python, api
+
+=========
+api.tasks
+=========
+
+.. contents::
+    :local:
+.. currentmodule:: api.tasks
+
+.. automodule:: api.tasks
+    :members:
+    :undoc-members:
+
+    .. autofunction:: build_layer(layer)
+    .. autofunction:: destroy_layer(layer)
+    .. autofunction:: build_node(node)
+    .. autofunction:: destroy_node(node)
+    .. autofunction:: converge_node(node)
+    .. autofunction:: run_node(node, command)
+    .. autofunction:: build_formation(formation)
+    .. autofunction:: destroy_formation(formation)
+    .. autofunction:: converge_formation(formation)
+    .. autofunction:: build_app(app)
+    .. autofunction:: destroy_app(app)
+    .. autofunction:: converge_controller()