openstack/zaqar
Code Issues Proposed changes

Fix doc build if git is absent

Browse Source 
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.

Change-Id: I48c6fb8bc25f651626d2751923f6a15b9939784c
Closes-Bug: #1552251
This commit is contained in:
pawnesh.kumar 2016-10-06 11:42:58 +05:30 committed by wangxiyuan
parent 69df4317d9
commit f3b4745398
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/conf.py
View File

@ -15,6 +15,7 @@
import os import os
import subprocess import subprocess
import sys import sys
import warnings
# If extensions (or modules to document with autodoc) are in another directory, # 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 # add these directories to sys.path here. If the directory is relative to the
@ -160,10 +161,15 @@ html_static_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y' #html_last_updated_fmt = '%b %d, %Y'
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
"-n1"] "-n1"]
html_last_updated_fmt = subprocess.Popen(git_cmd, try:
stdout=subprocess.PIPE).communicate()[0] html_last_updated_fmt = subprocess.Popen(
git_cmd, stdout=subprocess.PIPE).communicate()[0]
except Exception:
warnings.warn('Cannot get last updated time from git repository. '
'Not setting "html_last_updated_fmt".')
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.