aboutsummaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2019-03-07 14:26:45 +0000
committerPeter Maydell <peter.maydell@linaro.org>2019-03-07 14:26:45 +0000
commit4fad3864a88170fd16f59b73b0d6a3b3c29692dc (patch)
tree4b4b52632706fa6b3341af24110662f4997a9852 /docs/conf.py
parent07fd6563ae435cc78ec64d245a59d13373c2c686 (diff)
docs/conf.py: Configure the 'alabaster' theme
Add the 'navigation' bar to the sidebar, which for some reason is not enabled by default. Remove 'relations', which is effectively disabled anyway and isn't useful for us. This requires that we mandate having at least Sphinx 1.3, where the theme was added. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Acked-by: Aleksandar Markovic <amarkovic@wavecomp.com> Message-id: 20190305172139.32662-6-peter.maydell@linaro.org Message-id: 20190228145624.24885-6-peter.maydell@linaro.org
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py
index e1d08a34a6..d118757cbd 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -25,7 +25,8 @@
# If your documentation needs a minimal Sphinx version, state it here.
#
-# needs_sphinx = '1.0'
+# 1.3 is where the 'alabaster' theme was shipped with Sphinx.
+needs_sphinx = '1.3'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -106,7 +107,8 @@ html_theme = 'alabaster'
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
- 'relations.html', # needs 'show_related': True theme option to display
+ 'about.html',
+ 'navigation.html',
'searchbox.html',
]
}