[lld] 7f00938 - lld docs config: Use a list key in html_sidebars
Hans Wennborg via llvm-commits
llvm-commits at lists.llvm.org
Thu Aug 20 07:48:19 PDT 2020
Author: Hans Wennborg
Date: 2020-08-20T16:48:06+02:00
New Revision: 7f009389752c758ccd9f7cc46867e991d482933e
URL: https://github.com/llvm/llvm-project/commit/7f009389752c758ccd9f7cc46867e991d482933e
DIFF: https://github.com/llvm/llvm-project/commit/7f009389752c758ccd9f7cc46867e991d482933e.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 7867d9a7dddf..da03afedf563 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.
More information about the llvm-commits
mailing list