From mboxrd@z Thu Jan 1 00:00:00 1970 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 90E08C433F5 for ; Tue, 4 Oct 2022 20:12:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229764AbiJDUMl (ORCPT ); Tue, 4 Oct 2022 16:12:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49374 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229603AbiJDUMh (ORCPT ); Tue, 4 Oct 2022 16:12:37 -0400 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5119526126; Tue, 4 Oct 2022 13:12:36 -0700 (PDT) Received: from meer.lwn.net (unknown [IPv6:2601:281:8300:73::5f6]) by ms.lwn.net (Postfix) with ESMTPA id 873884B0; Tue, 4 Oct 2022 20:12:35 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 873884B0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1664914355; bh=pTPVZaeeJh0pVq8eQZg8QLde/V+YESX5niUBMm79s9o=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=ZuBL3W96SMr+tG6HClnOWvrBUJrR0VDnq8Su03jY/0TbURTi2/7qW3i01/tCeX/ly uxY3WHJzqr23Z85MeXaUIJC9fbV3d4Yx0QquK5ezQX23RxmDhuIYKbUQDEG+NMNgUJ grTjXsBMTe0mK1VG184z5ipcsMGZQ68vV0hWSS4aRsIQgF+5706U0tx+gyxkdhP8xy GOotBOvAhTldlsBSl/6usiSyMFQylKYINYmDg1awwa4ILn1J7Vn4UVjEMKhRJgvtxC /fBpogGscw/fAadq6tFp31RxowRp4kIya1BXF/qODYtJmrbxMzUvWPoxfmQ/2nC2ux xCucCI+wjwE6A== From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Jani Nikula , Mauro Carvalho Chehab , Jonathan Corbet Subject: [PATCH 1/5] docs: Switch the default HTML theme to alabaster Date: Tue, 4 Oct 2022 14:12:18 -0600 Message-Id: <20221004201222.281845-2-corbet@lwn.net> X-Mailer: git-send-email 2.37.2 In-Reply-To: <20221004201222.281845-1-corbet@lwn.net> References: <20221004201222.281845-1-corbet@lwn.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 = release = "unknown version" +# +# 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 the +# command-line options and find it for ourselves. +# +def get_cline_version(): + c_version = c_release = '' + for arg in sys.argv: + if arg.startswith('version='): + c_version = arg[8:] + elif arg.startswith('release='): + c_release = 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 = 'none' # a list of builtin themes. # Default theme -html_theme = 'sphinx_rtd_theme' +html_theme = 'alabaster' html_css_files = [] if "DOCS_THEME" in os.environ: @@ -324,6 +342,10 @@ if html_theme == 'classic': 'bodyfont': "serif", 'headfont': "sans-serif", } +else: + html_theme_options = { + 'description': get_cline_version(), + } sys.stderr.write("Using %s theme\n" % html_theme) @@ -371,7 +393,7 @@ html_use_smartypants = False # Custom sidebar templates, maps document names to template names. # Note that the RTD theme ignores this -html_sidebars = { '**': ['searchbox.html', 'localtoc.html', 'sourcelink.html']} +html_sidebars = { '**': ["about.html", 'searchbox.html', 'localtoc.html', 'sourcelink.html']} # Additional templates that should be rendered to pages, maps page names to # template names. -- 2.37.2