Adding support for opening an issue from any page.

dhermes · dhermes · commit 6e9c5484e914 · 2015-02-24T22:52:52.000-08:00
- Anchored as part of <header class="page-header fixed"> - Still needs work for responsive parts (small page sizes) - Link has a template with information about the page the issue is filed from Fixes googleapis#98.
diff --git a/docs/_static/css/main.css b/docs/_static/css/main.css
@@ -745,6 +745,12 @@ h2 .headerlink:hover {
     opacity: 0.3;
 }
 
+#file-issue {
+  position: absolute;
+  right: 20px;
+  top: 20px;
+}
+
 .v-list {
     color: rgba(0,0,0,0.2);
 }
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
@@ -81,6 +81,13 @@ <h1 class="logo">
           </li>
         </ul>
       </nav><!-- end of .main-nav -->
+      {%- if show_source and has_source and pagename %}
+      {%- set issue_uri = issue_uri_template.format(pagename, release) %}
+      {%- endif %}
+      <a href="{{ issue_uri }}" target="_blank" class="v-btn" id="file-issue">
+        <img src="_static/images/icon-link-github.svg" />
+        Report an Issue
+      </a>
     </header><!-- end of .page-header -->
     {% endblock %}
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -13,6 +13,7 @@
 
 from pkg_resources import get_distribution
 import sys, os
+import urllib
 
 # 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
@@ -179,6 +180,8 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'gclouddoc'
 
+html_context = {}
+
 
 # -- Options for LaTeX output --------------------------------------------------
 
@@ -257,3 +260,14 @@
 # This pulls class descriptions from the class docstring,
 # and parameter definitions from the __init__ docstring.
 autoclass_content = 'both'
+
+issue_uri = ('https://github.com/GoogleCloudPlatform/gcloud-python/issues/'
+             'new?' + urllib.urlencode({'title': '[Documentation Issue] '}))
+issue_uri_template = (
+    issue_uri + '&' + urllib.urlencode({'body': 'Page Name: '}) + '{0}' +
+    urllib.quote('\nRelease: ') + '{1}')
+
+html_context.update(
+    issue_uri=issue_uri,
+    issue_uri_template=issue_uri_template,
+)

Original file line number	Diff line number	Diff line change
`@@ -745,6 +745,12 @@ h2 .headerlink:hover {`
`745`	`745`	`opacity: 0.3;`
`746`	`746`	`}`
`747`	`747`
	`748`	`+#file-issue {`
	`749`	`+ position: absolute;`
	`750`	`+ right: 20px;`
	`751`	`+ top: 20px;`
	`752`	`+}`
	`753`	`+`
`748`	`754`	`.v-list {`
`749`	`755`	`color: rgba(0,0,0,0.2);`
`750`	`756`	`}`