openstack/manila
Code Issues Proposed changes

Fix html_last_updated_fmt in conf.py

Browse Source 
1. remove duplicate html_last_updated_fmt in doc/source/conf.py
   the second one cause the new added one not take effect.
2. update html_last_updated_fmt in api-ref/source/conf.py
   use the recommended '%Y-%m-%d %H:%M' data time format.

Change-Id: Ib37b8a05c88667b34438186c55b6eb3f64b64960
This commit is contained in:
junboli 2017-09-09 23:01:08 +08:00
parent 3832e04440
commit ee66db5dc9
2 changed files with 1 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
api-ref/source/conf.py
View File

@ -23,9 +23,7 @@
# serve to show the default. # serve to show the default.
import os import os
import subprocess
import sys import sys
import warnings
import openstackdocstheme import openstackdocstheme
@ -174,13 +172,7 @@ todo_include_todos = False
# If not None, a 'Last updated on:' timestamp is inserted at every page # If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format. # bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'. # The empty string is equivalent to '%b %d, %Y'.
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", html_last_updated_fmt = '%Y-%m-%d %H:%M'
"-n1"]
try:
html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
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.

9
doc/source/conf.py
View File

@ -210,15 +210,6 @@ html_theme_options = {}
# 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", "-n1"
]
try:
import subprocess
html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
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.