Skip to content

Commit eacbe1c

Browse files
committed
[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. llvm-svn: 372432
1 parent 63ddbc2 commit eacbe1c

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

llvm/docs/_templates/indexsidebar.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,10 @@
33

44
<h3>Bugs</h3>
55

6-
<p>LLVM bugs should be reported to
7-
<a href="http://llvm.org/bugs">Bugzilla</a>.</p>
6+
<p>Information on submitting bugs can be found
7+
<a href="https://llvm.org/docs/HowToSubmitABug.html">here</a>.</p>
8+
9+
<h3>FAQ</h3>
10+
11+
<p> A list of
12+
<a href="https://llvm.org/docs/FAQ.html">frequently asked questions</a> about LLVM.</p>

llvm/docs/conf.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
# Theme options are theme-specific and customize the look and feel of a theme
100100
# further. For a list of options available for each theme, see the
101101
# documentation.
102-
html_theme_options = { "nosidebar": True }
102+
html_theme_options = { "nosidebar": False }
103103

104104
# Add any paths that contain custom themes here, relative to this directory.
105105
html_theme_path = ["_themes"]
@@ -134,7 +134,14 @@
134134
#html_use_smartypants = True
135135

136136
# Custom sidebar templates, maps document names to template names.
137-
html_sidebars = {'index': 'indexsidebar.html'}
137+
138+
html_sidebars = {
139+
'**': [
140+
'indexsidebar.html',
141+
'sourcelink.html',
142+
'searchbox.html',
143+
]
144+
}
138145

139146
# Additional templates that should be rendered to pages, maps page names to
140147
# template names.

0 commit comments

Comments
 (0)