diff options
| author | DeForest Richards <d4m1887@gmail.com> | 2019-09-20 22:16:39 +0000 |
|---|---|---|
| committer | DeForest Richards <d4m1887@gmail.com> | 2019-09-20 22:16:39 +0000 |
| commit | eacbe1cccc40ddd8874fcdbbee2cb9f8a842f4b5 (patch) | |
| tree | 0fce3d2acc299975997d63d9ee34889572565d95 | |
| parent | 63ddbc2fbc31f2ef32f61d7c603d42bb92a7dcbd (diff) | |
| download | bcm5719-llvm-eacbe1cccc40ddd8874fcdbbee2cb9f8a842f4b5.tar.gz bcm5719-llvm-eacbe1cccc40ddd8874fcdbbee2cb9f8a842f4b5.zip | |
[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
| -rw-r--r-- | llvm/docs/_templates/indexsidebar.html | 9 | ||||
| -rw-r--r-- | llvm/docs/conf.py | 11 |
2 files changed, 16 insertions, 4 deletions
diff --git a/llvm/docs/_templates/indexsidebar.html b/llvm/docs/_templates/indexsidebar.html index 416174279ce..dbd85f06a04 100644 --- a/llvm/docs/_templates/indexsidebar.html +++ b/llvm/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/llvm/docs/conf.py b/llvm/docs/conf.py index a0357cf3cb8..c92ede3ea44 100644 --- a/llvm/docs/conf.py +++ b/llvm/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. |

