From nobody Tue Apr 7 06:33:39 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id D729EC433F5 for ; Tue, 11 Oct 2022 19:01:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229989AbiJKTBJ (ORCPT ); Tue, 11 Oct 2022 15:01:09 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54560 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229538AbiJKTA7 (ORCPT ); Tue, 11 Oct 2022 15:00:59 -0400 Received: from ms.lwn.net (ms.lwn.net [IPv6:2600:3c01:e000:3a1::42]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E74B48304D; Tue, 11 Oct 2022 12:00:57 -0700 (PDT) Received: from meer.lwn.net (unknown [IPv6:2601:281:8300:73::5f6]) by ms.lwn.net (Postfix) with ESMTPA id 56D987F9; Tue, 11 Oct 2022 19:00:57 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 56D987F9 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1665514857; bh=pTPVZaeeJh0pVq8eQZg8QLde/V+YESX5niUBMm79s9o=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=XUL1z5BFOIV/rptuJr5HafYkGIzefr35U7LAGoQL2iSQKSGDXr290q5QK756yzoug a5LZFj9Wow7Lv+i+rTJK0Z6KK5oRA0gt8e5R5J1LobSoLrr4av7owJoA2gcaF0YNxq 1Udq9LQiVtyIanDVd1teFLd4l21V6Q6QHRyG+wk9OvRASSnxFLwTlKZjcBN1k12SXC ok4PkqA9/Ct8Cad2XqDlewe/iEtY8fJ7mhjR2+7I9lDgTuthC0SC1xacBJtYVCtOcm I7PjgrR1464rBhB4wQnwEvwW6Vi+unzTvKe5o/ViCFYLZfFzf7m2SNUgSamS53QzMQ murVV8hUxVGug== From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Jani Nikula , Mauro Carvalho Chehab , Jonathan Corbet Subject: [PATCH v2 1/6] docs: Switch the default HTML theme to alabaster Date: Tue, 11 Oct 2022 13:00:42 -0600 Message-Id: <20221011190047.749145-2-corbet@lwn.net> X-Mailer: git-send-email 2.37.2 In-Reply-To: <20221011190047.749145-1-corbet@lwn.net> References: <20221011190047.749145-1-corbet@lwn.net> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" The read-the-docs theme is not entirely attractive and doesn't give us control over the left column. "Alabaster" is deemed the default Sphinx theme, it is currently maintained and shipped bundled with Sphinx itself, so there is no need to install it separately. Switch over to this theme as the default for building kernel documentation; the DOCS_THEME environment variable can still be used to select a different theme. Signed-off-by: Jonathan Corbet --- Documentation/conf.py | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/Documentation/conf.py b/Documentation/conf.py index 22c9d4df1967..629f4afeb0eb 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -194,6 +194,24 @@ finally: else: version =3D release =3D "unknown version" =20 +# +# HACK: there seems to be no easy way for us to get at the version and +# release information passed in from the makefile...so go pawing through t= he +# command-line options and find it for ourselves. +# +def get_cline_version(): + c_version =3D c_release =3D '' + for arg in sys.argv: + if arg.startswith('version=3D'): + c_version =3D arg[8:] + elif arg.startswith('release=3D'): + c_release =3D arg[8:] + if c_version: + if c_release: + return c_version + '-' + c_release + return c_version + return version # Whatever we came up with before + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # @@ -247,7 +265,7 @@ highlight_language =3D 'none' # a list of builtin themes. =20 # Default theme -html_theme =3D 'sphinx_rtd_theme' +html_theme =3D 'alabaster' html_css_files =3D [] =20 if "DOCS_THEME" in os.environ: @@ -324,6 +342,10 @@ if html_theme =3D=3D 'classic': 'bodyfont': "serif", 'headfont': "sans-serif", } +else: + html_theme_options =3D { + 'description': get_cline_version(), + } =20 sys.stderr.write("Using %s theme\n" % html_theme) =20 @@ -371,7 +393,7 @@ html_use_smartypants =3D False =20 # Custom sidebar templates, maps document names to template names. # Note that the RTD theme ignores this -html_sidebars =3D { '**': ['searchbox.html', 'localtoc.html', 'sourcelink.= html']} +html_sidebars =3D { '**': ["about.html", 'searchbox.html', 'localtoc.html'= , 'sourcelink.html']} =20 # Additional templates that should be rendered to pages, maps page names to # template names. --=20 2.37.2