Merge lp:~javier.collado/utah/bug1076437 into lp:utah

[Javier Collado]

This branch fixes the problem to build the documentation in readthedocs.org

Aside from that, version has been updated to be in sync with debian/changelog and a few pep8 errors in the configuration file have been fixed.

To make sure that the documentation now builds fine I created a temporary project that you can take a look at it here:

https://utah-test.readthedocs.org/en/latest/

[Max Brustkern (nuclearbob)]

Looks good to me.

As a question, on lines 17-20, it looks like general parenthesis continuation is done with 4 spaces rather than 8. Is that the standard we should be using elsewhere if we're not trying to line things up with the parenthesis?

review: Approve

[Javier Collado (javier.collado)]

@Max

Yes, there are some warnings/errors in the new version of the pep8 (tool)
that address over/under-indentation.

What PEP8 (document) says, with regard to that is:
---
Use 4 spaces per indentation level.

For really old code that you don't want to mess up, you can continue to use 8-space tabs.

Continuation lines should align wrapped elements either vertically using Python's implicit line joining inside parentheses, brackets and braces, or using a hanging indent. When using a hanging indent the following considerations should be applied; there should be no arguments on the first line and further indentation should be used to clearly distinguish itself as a continuation line.
---

To get some small examples you can use: "pep8 --show-pep8 <file>". Anyway, as usual,
my advice is to integrate that tool (or pyflakes) into your preferred editor
and get the warnings/errors as you write.

Once all those issues are continuously highlighted, they get so annoying that you end up
fixing them sooner or later.

=== modified file 'docs/source/conf.py'
--- docs/source/conf.py	2012-11-07 09:15:44 +0000
+++ docs/source/conf.py	2012-11-08 16:27:04 +0000
@@ -64,7 +64,7 @@
 # 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'):
+                 'apt', 'apt.cache', 'netifaces'):
     sys.modules[mod_name] = ModuleMock(mod_name)
 
 
@@ -74,11 +74,11 @@
 
     help_lines = parser.format_help().splitlines()
     options_lines = itertools.dropwhile(
-            lambda l: l != 'optional arguments:',
-            help_lines)  # Drop usage
+        lambda l: l != 'optional arguments:',
+        help_lines)  # Drop usage
     options_lines = itertools.takewhile(
-            lambda l: bool(l),
-            options_lines)  # Drop epilog
+        lambda l: bool(l),
+        options_lines)  # Drop epilog
     options_lines.next()  # Drop first line
 
     def fix_line(line):
@@ -169,9 +169,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.4'
+version = '0.5'
 # The full version, including alpha/beta/rc tags.
-release = '0.4'
+release = '0.5'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -292,22 +292,22 @@
 # -- 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': '',
+    # 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', 'UTAH.tex', u'UTAH Documentation',
-   u'Canonical Ltd', 'manual'),
+    ('index', 'UTAH.tex', u'UTAH Documentation',
+     u'Canonical Ltd', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -339,14 +339,14 @@
     ('man/utah', 'utah', u'UTAH client test runner',
      [u'Canonical Ltd'], 1),
     ('man/run_install_test.py', 'run_install_test.py',
-      u'UTAH server test runner (provisioning)', [u'Canonical Ltd'], 1),
+     u'UTAH server test runner (provisioning)', [u'Canonical Ltd'], 1),
     ('man/run_test_cobbler.py', 'run_test_cobbler.py',
      u'UTAH server test runner (physical hardware)', [u'Canonical Ltd'], 1),
     ('man/run_test_vm.py', 'run_test_vm.py',
      u'UTAH server test runner (virtual hardware)',
      [u'Canonical Ltd'], 1),
     ('man/run_utah_tests.py', 'run_utah_tests.py',
-      u'UTAH server test runner (any hardware)', [u'Canonical Ltd'], 1),
+     u'UTAH server test runner (any hardware)', [u'Canonical Ltd'], 1),
 ]
 
 # If true, show URL addresses after external links.
@@ -359,9 +359,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'UTAH', u'UTAH Documentation',
-   u'Canonical Ltd', 'UTAH', 'One line description of project.',
-   'Miscellaneous'),
+    ('index', 'UTAH', u'UTAH Documentation',
+     u'Canonical Ltd', 'UTAH', 'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.