openstack/neutron-lib
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.

Closes-Bug: #1552251
Change-Id: I9465e116e52517fecc651ef01d8e3fc7b78b7e48
This commit is contained in:
Tony Xu 2016-10-24 09:56:32 +08:00
parent a420cf8f5e
commit 3c4196041d
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/conf.py
View File

@ -24,6 +24,7 @@
import os
import subprocess
import sys
import warnings
# 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
@ -163,9 +164,13 @@ modindex_common_prefix = ['neutron_lib.']
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
"-n1"]
html_last_updated_fmt = subprocess.Popen(
git_cmd, stdout=subprocess.PIPE).communicate()[0]
"-n1"]
try:
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
# typographically correct entities.