maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[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
This commit is contained in:
DeForest Richards 2019-09-20 22:16:39 +00:00
parent 63ddbc2fbc
commit eacbe1cccc
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
llvm/docs/_templates/indexsidebar.html vendored
View File

@ -3,5 +3,10 @@
<h3>Bugs</h3> <h3>Bugs</h3>
<p>LLVM bugs should be reported to <p>Information on submitting bugs can be found
<a href="http://llvm.org/bugs">Bugzilla</a>.</p> <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>

11
llvm/docs/conf.py
View File

@ -99,7 +99,7 @@ html_theme = 'llvm-theme'
# Theme options are theme-specific and customize the look and feel of a 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 # further. For a list of options available for each theme, see the
# documentation. # documentation.
html_theme_options = { "nosidebar": True } html_theme_options = { "nosidebar": False }
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ["_themes"] html_theme_path = ["_themes"]
@ -134,7 +134,14 @@ html_last_updated_fmt = '%Y-%m-%d'
#html_use_smartypants = True #html_use_smartypants = True
# Custom sidebar templates, maps document names to template names. # 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 # Additional templates that should be rendered to pages, maps page names to
# template names. # template names.