openstack/openstackdocstheme
Code Issues Proposed changes

Update log-a-bug comments

Browse Source 
Enhance comments for conf.py. Remove now obsolete variable pwd.

Co-Authored-By: Bernd Bausch <berndbausch@gmail.com>
Change-Id: If339d286437547a2d319cc0a270d97ef39d69784
This commit is contained in:
Andreas Jaeger
2015-10-06 13:56:12 +02:00
parent dde1e90303
commit 4c9da40a7b
1 changed files with 7 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/conf.py
View File

@@ -49,9 +49,6 @@ master_doc = 'index'
# and should ultimately be set automatically by the build process # and should ultimately be set automatically by the build process
project = u'network guide' project = u'network guide'
copyright = u'2015, OpenStack Contributors' copyright = u'2015, OpenStack Contributors'
# "giturl" contains the location of conf.py in Git. log-a-bug requires it to
# automatically build a complete bug description.
giturl = u'http://git.openstack.org/cgit/openstack/openstackdocstheme/tree/doc/source'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@@ -64,17 +61,16 @@ version = '1.0'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '1.0' release = '1.0'
# We ask git for the SHA checksum # A few variables have to be set for the log-a-bug feature.
# The git SHA checksum is used by "log-a-bug" # 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/openstackdocstheme/tree/doc/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n') gitsha = os.popen(git_cmd).read().strip('\n')
# tag that reported bugs will be tagged with when using the "log a bug"
# clickthrough on each page, such as user-guide or install-guide
bug_tag = "doc-builds" bug_tag = "doc-builds"
# source tree html_context = {"gitsha": gitsha, "bug_tag": bug_tag, "giturl" : giturl}
pwd = os.getcwd()
# html_context allows us to pass arbitrary values into the html template
html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag, "giturl" : giturl }
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.