diff options
| author | Colleen Murphy <colleen@gazlene.net> | 2017-04-17 07:38:04 +0200 |
|---|---|---|
| committer | Colleen Murphy <colleen@gazlene.net> | 2017-04-17 07:44:47 +0200 |
| commit | c7ab7c567792bafddc61fff003910df159aea7a5 (patch) | |
| tree | bc17c6eab7b69978c3c22d8912930503314e3e33 /api-ref/source/conf.py | |
| parent | 4dd73a8543dad565a032730bbe08597c87baa24a (diff) | |
| download | keystone-c7ab7c567792bafddc61fff003910df159aea7a5.tar.gz | |
Fix doc generation for python 3
1. The html_last_updated_fmt sphinx setting was providing a byte string
where sphinx expected a str, which produced warnings (and therefore
failures):
WARNING: The config value `html_last_updated_fmt' has type `bytes', expected to ['str'].
The solution provided is copied from cinder's solution[1].
2. The .keys() method in python 3 returns a dict_keys object rather than
a list and it does not include a .sort() method. This patch swaps
.sort() out for the global function sorted() which works in both python
2 and python 3.
This came up because on some newer distros that don't install python 2
by default, virtualenv defaults to creating a python 3 environment when
none is specified.
[1] https://review.openstack.org/#/c/433081
Change-Id: I68b796fa2e33fd6c3df67b542def31e6ba620944
Diffstat (limited to 'api-ref/source/conf.py')
| -rw-r--r-- | api-ref/source/conf.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 0e1948206..e20118667 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -171,8 +171,8 @@ pygments_style = 'sphinx' git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", "-n1"] try: - html_last_updated_fmt = subprocess.Popen( - git_cmd, stdout=subprocess.PIPE).communicate()[0] + 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".') |