[Docs] Add a custom sidebar to doc pages

Adds a custom sidebar to LLVM docs. Sidebar includes links to How to submit a bug and FAQ topics, as well as a Show Source link and search box.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@372432 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/docs/_templates/indexsidebar.html b/docs/_templates/indexsidebar.html
index 416174279ce48fc879bbb56f451f30767d508bef..dbd85f06a048f8c4b140587ac4c935e66a617887 100644 (file)
--- a/docs/_templates/indexsidebar.html
+++ b/docs/_templates/indexsidebar.html
@@ -3,5 +3,10 @@
 
 <h3>Bugs</h3>
 
-<p>LLVM bugs should be reported to
-  <a href="http://llvm.org/bugs">Bugzilla</a>.</p>
+<p>Information on submitting bugs can be found
+  <a href="https://llvm.org/docs/HowToSubmitABug.html">here</a>.</p>
+
+<h3>FAQ</h3>
+
+<p> A list of
+  <a href="https://llvm.org/docs/FAQ.html">frequently asked questions</a> about LLVM.</p>
\ No newline at end of file

diff --git a/docs/conf.py b/docs/conf.py
index a0357cf3cb8ac83f037dca97840e951d8886f754..c92ede3ea44b6467df358baeb549087e2c4e55ec 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -99,7 +99,7 @@ html_theme = 'llvm-theme'
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = { "nosidebar": True }
+html_theme_options = { "nosidebar": False }
 
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ["_themes"]
@@ -134,7 +134,14 @@ html_last_updated_fmt = '%Y-%m-%d'
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-html_sidebars = {'index': 'indexsidebar.html'}
+
+html_sidebars = {
+    '**': [
+        'indexsidebar.html',
+        'sourcelink.html',
+        'searchbox.html',
+    ]
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.