Merge lp:~mpontillo/maas/git-bzr-doc-fix into lp:~maas-committers/maas/trunk

[Mike Pontillo]

Fake out bzr_* variables for git-based sandboxes when building docs, in order to allow git-based sandboxes to build the docs.

This change allows 'make doc' to work correctly in a git sandbox. (that is, a sandbox cloned using the 'git-bzr-ng' package)

When 'make doc' is run, the code shells out to run 'bzr' commands to determine the current revision, etc.

Since developing using git isn't officially supported, this is simply a hack to allow it the build to succeed.

[Raphaël Badin (rvb)]

Looks good! Thanks.

review: Approve

=== modified file 'docs/conf.py'
--- docs/conf.py	2014-10-16 01:50:05 +0000
+++ docs/conf.py	2015-02-16 15:47:22 +0000
@@ -284,10 +284,17 @@
 intersphinx_mapping = {'http://docs.python.org/': None}
 
 # Gather information about the branch and the build date.
-from subprocess import check_output
-bzr_last_revision_number = check_output(['bzr', 'revno'])
-bzr_last_revision_date = check_output(['bzr', 'version-info', '--template={date}', '--custom'])
-bzr_build_date = check_output(['bzr', 'version-info', '--template={build_date}', '--custom'])
+from subprocess import check_output, CalledProcessError
+try:
+    bzr_last_revision_number = check_output(['bzr', 'revno'])
+    bzr_last_revision_date = check_output(['bzr', 'version-info', '--template={date}', '--custom'])
+    bzr_build_date = check_output(['bzr', 'version-info', '--template={build_date}', '--custom'])
+except (CalledProcessError):
+    # not a bzr repository
+    bzr_last_revision_number = 'unknown'
+    bzr_last_revision_date = check_output(['date', '-u', '+%Y-%m-%d %H:%M:%S %z'])
+    bzr_build_date = bzr_last_revision_date
+
 
 # Populate html_context with the variables used in the templates.
 html_context = {