Browse Source

Point roles docs bugs to openstack-ansible LP

Currently when clicking on the small bug in the roles'
docs, we land on openstack-manuals launchpad.

This should solve it.

Change-Id: Ia6788162ca5cf09db374e221d0997e6adc91b15b
tags/15.0.0.0b2
Jean-Philippe Evrard 2 years ago
parent
commit
77d2bcaf2f
1 changed files with 18 additions and 1 deletions
  1. 18
    1
      doc/source/conf.py

+ 18
- 1
doc/source/conf.py View File

@@ -22,9 +22,9 @@
22 22
 # All configuration values have a default; values that are commented out
23 23
 # serve to show the default.
24 24
 
25
+import openstackdocstheme
25 26
 import pbr.version
26 27
 import os
27
-import openstackdocstheme
28 28
 
29 29
 # If extensions (or modules to document with autodoc) are in another directory,
30 30
 # 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()
83 83
 # The short X.Y version.
84 84
 version = version_info.canonical_version_string()
85 85
 
86
+# A few variables have to be set for the log-a-bug feature.
87
+#   giturl: The location of conf.py on Git. Must be set manually.
88
+#   gitsha: The SHA checksum of the bug description.
89
+#           Automatically extracted from git log.
90
+#   bug_tag: Tag for categorizing the bug. Must be set manually.
91
+# These variables are passed to the logabug code via html_context.
92
+giturl = ("http://git.openstack.org/cgit/openstack/{0}"
93
+          "/tree/doc/source").format(target_name)
94
+git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
95
+gitsha = os.popen(git_cmd).read().strip('\n')
96
+bug_project = project.lower()
97
+bug_title = "Documentation bug"
98
+html_context = {"gitsha": gitsha, "giturl": giturl,
99
+                "bug_tag": "docs", "bug_title": bug_title,
100
+                "bug_project": bug_project}
101
+
86 102
 # The language for content autogenerated by Sphinx. Refer to documentation
87 103
 # for a list of supported languages.
88 104
 #
@@ -307,6 +323,7 @@ texinfo_documents = [
307 323
 # If true, do not generate a @detailmenu in the "Top" node's menu.
308 324
 # texinfo_no_detailmenu = False
309 325
 
326
+
310 327
 watermark = os.popen("git branch --contains $(git rev-parse HEAD)\
311 328
 | awk -F/ '/stable/ {print $2}'").read().strip(' \n\t').capitalize()
312 329
 if watermark == "":

Loading…
Cancel
Save