summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2017-10-26 00:04:23 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2017-10-26 00:04:23 +0900
commitc0aa0ce2d8bd96406f785dd5d225eca68b32b69b (patch)
treead4a50fc86df9de77d19ff5659e150f81d510db2
parent6288eac1ece9b1d684d8611c32afb027d56b0033 (diff)
downloadsphinx-git-c0aa0ce2d8bd96406f785dd5d225eca68b32b69b.tar.gz
Add hints for html_sidebars
-rw-r--r--sphinx/templates/quickstart/conf.py_t5
1 files changed, 5 insertions, 0 deletions
diff --git a/sphinx/templates/quickstart/conf.py_t b/sphinx/templates/quickstart/conf.py_t
index 9b321a404..4e828f330 100644
--- a/sphinx/templates/quickstart/conf.py_t
+++ b/sphinx/templates/quickstart/conf.py_t
@@ -110,6 +110,11 @@ html_static_path = ['{{ dot }}static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself. Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
# html_sidebars = {}