openstack/deb-mistral
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: I9a6aba18d40877f24c31d0b44cae4aca4b064655
Closes-Bug: #1552251
This commit is contained in:
Sharat Sharma 2017-01-31 17:18:36 +05:30
parent c9ef100219
commit 3d6184e51a
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/conf.py
View File

@ -14,7 +14,7 @@
import os import os
import subprocess import subprocess
import sys import sys
import warnings
on_rtd = os.environ.get('READTHEDOCS', None) == 'True' on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
@ -99,8 +99,12 @@ modindex_common_prefix = ['mistral.']
# 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"]
try:
html_last_updated_fmt = subprocess.Popen( html_last_updated_fmt = subprocess.Popen(
git_cmd, stdout=subprocess.PIPE).communicate()[0] 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".')
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".