[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] RFC: sphinx: adopt kernel readthedoc theme
From: |
Marc-André Lureau |
Subject: |
Re: [PATCH] RFC: sphinx: adopt kernel readthedoc theme |
Date: |
Mon, 16 Nov 2020 14:56:42 +0400 |
Hi,
On Thu, Nov 5, 2020 at 8:03 PM <marcandre.lureau@redhat.com> wrote:
>
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
>
> The default "alabaster" sphinx theme has a couple shortcomings:
> - the navbar moves along the page
> - the search bar is not always at the same place
> - it lacks some contrast and colours
>
> The "rtd" theme from readthedocs.org is a popular third party theme used
> notably by the kernel, with a custom style sheet. I like it better,
> perhaps others do too. It also has features that may come handy, such as
> "Edit on Gitlab".
>
> Tweak the nav header background to match qemu.org style, use the
> QEMU logo, and favicon.
>
> The html_theme_options['description'] workaround doesn't seem necessary.
>
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
> docs/conf.py | 36 +++----
> docs/devel/conf.py | 4 -
> docs/interop/conf.py | 4 -
> docs/specs/conf.py | 5 -
> docs/sphinx-static/theme_overrides.css | 137 +++++++++++++++++++++++++
> docs/system/conf.py | 4 -
> docs/tools/conf.py | 5 -
> docs/user/conf.py | 4 -
> 8 files changed, 155 insertions(+), 44 deletions(-)
> create mode 100644 docs/sphinx-static/theme_overrides.css
>
Am I the only one finding the default sphinx theme inferior to rtd ?
thanks