From ccd0db78f627c4a55f07d8dc2c97a450def62fa9 Mon Sep 17 00:00:00 2001 From: Matjaz Pancur Date: Mon, 12 Oct 2015 17:24:45 +0200 Subject: [PATCH] Update for openstackdocstheme 1.2.3 Also updates conf.py with a new gitrepo syntax. Change-Id: Iee601826922d1fcf445d3ee486c671dc5b20ef17 --- doc/upstream-training/conf.py | 14 ++++++++------ test-requirements.txt | 4 ++-- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/upstream-training/conf.py b/doc/upstream-training/conf.py index cf7ad5d7..ff65d71f 100644 --- a/doc/upstream-training/conf.py +++ b/doc/upstream-training/conf.py @@ -60,14 +60,16 @@ version = '0.0.1' # The full version, including alpha/beta/rc tags. release = '0.0.1' -# We ask git for the SHA checksum -# The git SHA checksum is used by "log-a-bug" +# A few variables have to be set for the log-a-bug feature. +# giturl: The location of conf.py on Git. Must be set manually. +# gitsha: The SHA checksum of the bug description. Automatically extracted from git log. +# bug_tag: Tag for categorizing the bug. Must be set manually. +# These variables are passed to the logabug code via html_context. +giturl = u'http://git.openstack.org/cgit/openstack/training-guides/tree/doc/upstream-training/' git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" gitsha = os.popen(git_cmd).read().strip('\n') -# source tree -pwd = os.popen("pwd").read().strip('\n') -# html_context allows us to pass arbitrary values into the html template -html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag} +html_context = {"gitsha": gitsha, "bug_tag": bug_tag, + "giturl": giturl} # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/test-requirements.txt b/test-requirements.txt index 710d7696..d39720cd 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,10 +2,10 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. doc8 # Apache-2.0 -pbr>=0.6,<1.0 +pbr>=1.6 oslosphinx openstack-doc-tools>=0.30 sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 -openstackdocstheme>=1.0.7 +openstackdocstheme>=1.2.3 hieroglyph>=0.7.1 bashate # pep8 equivalent for bash scripts \ No newline at end of file