Merge pull request #5 from njsmith/everybody-needs-help-sometimes

[docs] Add "need help?" box to the sidebar
python-trio · Aug 2, 2017 · 2be6c32 · 2be6c32
2 parents 98a9b20 + 7406a68
commit 2be6c32
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/source/_templates/need-help.html b/docs/source/_templates/need-help.html
@@ -0,0 +1,5 @@
+<div id="need-help">
+  <h3>Need help?</h3>
+  Try <a href="https://gitter.im/python-trio/general">chat</a> or <a
+  href="https://stackoverflow.com/questions/ask?tags=python+{{ project }}">StackOverflow</a>.
+</div>
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -45,6 +45,12 @@ def setup(app):
     #"python": ('https://docs.python.org/3', None),
 }
 
+html_sidebars = {
+    "**": [
+        "localtoc.html", "relations.html", "searchbox.html", "need-help.html",
+    ],
+}
+
 autodoc_member_order = "bysource"
 
 # Add any paths that contain templates here, relative to this directory.