Merge lp:~javier.collado/utah/documentation-fixes into lp:utah

[Javier Collado]

Documentation build in readthedocs.org is reporting two errors:

- bootspeed module isn't found
- Type error when calling: yaml.add_representer

This branch removes bootspeeed from the documentation (the module is no longer part of the code) and fixes the type error with a better version of the mocking code for readthedocs.org

[Javier Collado (javier.collado)]

Since this merge proposal is focused just on fixing the documentation build errors, I'm merging it right away. Anyway, if you have any comment, let me know and I can work on fixing any problem.

review: Approve

=== modified file 'docs/source/conf.py'
--- docs/source/conf.py	2012-08-20 11:33:46 +0000
+++ docs/source/conf.py	2012-09-03 09:53:24 +0000
@@ -19,21 +19,48 @@
 sys.path.insert(0, os.path.abspath('../..'))
 
 
-class Mock(type):
-    """
-    Mock class to avoid import errors when building the documentation
-    in readthedocs.org
-    """
+class ModuleMock(object):
+    """
+    Mock class to avoid import errors when building the documentation in
+    readthedocs.org
+    """
+    def __init__(self, name):
+        self.__name__ = name
+
     def __getattr__(self, name):
         full_name = '{0}.{1}'.format(self.__name__, name)
-        cls = Mock(full_name, (type,), {})
-        return cls
+
+        # Submodules are returned if they exist
+        if full_name in sys.modules:
+            return sys.modules[full_name]
+
+        # Members that start with an upper case letter
+        # are expected to be a class
+        if name[0].isupper():
+            obj = ClassMock
+        # otherwise, the are assumed to be a function
+        else:
+            def function(*args, **kwargs):
+                pass
+            obj = function
+        obj.__name__ = full_name
+        return obj
+
+
+class ClassMock(object):
+    """
+    Mock class to avoid module member access errors when building the
+    documentation in readthedocs.org
+    """
+    def __init__(self, *args, **kwargs):
+        pass
+
 
 # Mock all third party modules not available in the readthedocs.org environment
 for mod_name in ('psutil', 'yaml', 'paramiko', 'jsonschema', 'libvirt',
                  'bzrlib', 'bzrlib.builtins', 'bzrlib.plugin', 'bzrlib.errors',
                  'apt', 'apt.cache'):
-    sys.modules[mod_name] = Mock(mod_name, (type,), {})
+    sys.modules[mod_name] = ModuleMock(mod_name)
 
 # -- General configuration -----------------------------------------------------
 

=== modified file 'docs/source/reference.rst'
--- docs/source/reference.rst	2012-08-17 13:31:54 +0000
+++ docs/source/reference.rst	2012-09-03 09:53:24 +0000
@@ -90,9 +90,6 @@
 
 .. automodule:: utah.provisioning.inventory
 
-.. automodule:: utah.provisioning.inventory.bootspeed
-   :members:
-
 .. automodule:: utah.provisioning.inventory.exceptions
    :members: