openstack/oslo-incubator
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: Ibbfb81955e5e68553af551baeb17d4facd988e5c
Closes-Bug: #1552251
This commit is contained in:
Thomas Bechtold 2016-04-13 08:43:35 +02:00
parent 8748669941
commit 4f51acd317
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/conf.py
View File

@ -6,6 +6,7 @@ import sys
import os import os
import fileinput import fileinput
import fnmatch import fnmatch
import warnings
BASE_DIR = os.path.dirname(os.path.abspath(__file__)) BASE_DIR = os.path.dirname(os.path.abspath(__file__))
ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", "..")) ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
@ -77,11 +78,15 @@ pygments_style = 'sphinx'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", try:
"-n1"] git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
html_last_updated_fmt = subprocess.Popen(git_cmd, "-n1"]
stdout=subprocess.PIPE).\ html_last_updated_fmt = subprocess.Popen(git_cmd,
communicate()[0] stdout=subprocess.PIPE).\
communicate()[0]
except Exception:
warnings.warn('Cannot get last updated time from git repository. '
'Not setting "html_last_updated_fmt".')
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass # (source start file, target name, title, author, documentclass