[llvm-branch-commits] [lld] 07de36d - lld docs config: Use a list key in html_sidebars

[Hans Wennborg via llvm-branch-commits]

Author: Hans Wennborg
Date: 2020-08-20T16:45:40+02:00
New Revision: 07de36dbc817b67609e60e1e645d2faf3198da6e

URL: https://github.com/llvm/llvm-project/commit/07de36dbc817b67609e60e1e645d2faf3198da6e
DIFF: https://github.com/llvm/llvm-project/commit/07de36dbc817b67609e60e1e645d2faf3198da6e.diff

LOG: lld docs config: Use a list key in html_sidebars

Otherwise the docs-lld-html target fails to build using recent Sphinx
with the following not very helpful error message:

An error happened in rendering the page index.
Reason: TemplateNotFound()

It turns out the values in the html_sidebars dictionary always need to be lists
now. See https://github.com/sphinx-doc/sphinx/issues/6186

Added: 
    

Modified: 
    lld/docs/conf.py

Removed: 
    


################################################################################
diff  --git a/lld/docs/conf.py b/lld/docs/conf.py
index 7d4fc0c5ad75..ee93c01f7f32 100644
--- a/lld/docs/conf.py
+++ b/lld/docs/conf.py
@@ -134,7 +134,7 @@
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-html_sidebars = {'index': 'indexsidebar.html'}
+html_sidebars = {'index': ['indexsidebar.html']}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.