[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 05/12] docs/conf.py: Configure the 'alabaster' theme
From: |
Peter Maydell |
Subject: |
[Qemu-devel] [PULL 05/12] docs/conf.py: Configure the 'alabaster' theme |
Date: |
Thu, 7 Mar 2019 15:24:43 +0000 |
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 <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Acked-by: Aleksandar Markovic <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
---
docs/conf.py | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index e1d08a34a65..d118757cbd3 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',
]
}
--
2.20.1
- [Qemu-devel] [PULL 00/12] sphinx queue, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 01/12] docs/cpu-hotplug.rst: Fix rST markup issues, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 02/12] docs: Convert memory.txt to rst format, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 04/12] docs/conf.py: Disable unused _static directory, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 05/12] docs/conf.py: Configure the 'alabaster' theme,
Peter Maydell <=
- [Qemu-devel] [PULL 07/12] docs/conf.py: Disable option warnings, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 06/12] docs/conf.py: Don't include rST sources in HTML build, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 03/12] docs: Commit initial files from sphinx-quickstart, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 10/12] Makefile: Abstract out "identify the pkgversion" code, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 09/12] Makefile, configure: Support building rST documentation, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 11/12] docs/conf.py: Don't hard-code QEMU version, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 08/12] docs: Provide separate conf.py for each manual we want, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 12/12] MAINTAINERS: Add entry for Sphinx documentation infrastructure, Peter Maydell, 2019/03/07
- Re: [Qemu-devel] [PULL 00/12] sphinx queue, no-reply, 2019/03/07
- Re: [Qemu-devel] [PULL 00/12] sphinx queue, Peter Maydell, 2019/03/07