diff --git a/doc/source/conf.py b/doc/source/conf.py index ed84948..c157270 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,9 +22,9 @@ # All configuration values have a default; values that are commented out # serve to show the default. +import openstackdocstheme import pbr.version import os -import openstackdocstheme # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -83,6 +83,22 @@ release = version_info.version_string_with_vcs() # The short X.Y version. version = version_info.canonical_version_string() +# 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 = ("http://git.openstack.org/cgit/openstack/{0}" + "/tree/doc/source").format(target_name) +git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" +gitsha = os.popen(git_cmd).read().strip('\n') +bug_project = project.lower() +bug_title = "Documentation bug" +html_context = {"gitsha": gitsha, "giturl": giturl, + "bug_tag": "docs", "bug_title": bug_title, + "bug_project": bug_project} + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # @@ -307,6 +323,7 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False + watermark = os.popen("git branch --contains $(git rev-parse HEAD)\ | awk -F/ '/stable/ {print $2}'").read().strip(' \n\t').capitalize() if watermark == "":