From nobody Mon Apr 6 19:40:30 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 52B72C4332F for ; Thu, 13 Oct 2022 17:29:59 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229496AbiJMR35 (ORCPT ); Thu, 13 Oct 2022 13:29:57 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48218 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229861AbiJMR3a (ORCPT ); Thu, 13 Oct 2022 13:29:30 -0400 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C0E61D038E; Thu, 13 Oct 2022 10:29:28 -0700 (PDT) Received: from meer.lwn.net (unknown [IPv6:2601:281:8300:73:8b7:7001:c8aa:b65f]) by ms.lwn.net (Postfix) with ESMTPA id 44F0C7DE; Thu, 13 Oct 2022 17:29:28 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 44F0C7DE DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1665682168; bh=keh3BAATlkR8yDL2srU6MNeKVExwzXPbSFhQxtmEIdk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=s332vN68n3jqb2xYS+ZyYgEsAFrNsqsWuUvhcbLuNPL0CzQXC+PVGOSKII3104BSk l1SzFbQdQGXojU0xubGNluP7x9pCPqnCpf9x2Jf2wuSs9ucB951+ByUhA6n65n6Yge bZJYhrg7rgIKOPue9b882fj8UBGLN1Ll52ZEXq+2WFy1KQgJ6JrWWsJ1vBwf6ByQYU aB4HswMJiJfBXIG6ipVKRzmEEgR5lsQxC0mrOtbFX4UUrs6Tk/HOi3BxXLN2Bs/ad3 3yBSA5XOvk4gRhiKgA5ZXHnA/YJobyYqpmQWa4/krZ4VRu8ULQJNuJsJtTR+Yyc22B 1InmJOhTu3B5w== From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Subject: [PATCH v3 6/6] docs: decruft Documentation/conf.py Date: Thu, 13 Oct 2022 11:29:18 -0600 Message-Id: <20221013172918.846856-7-corbet@lwn.net> X-Mailer: git-send-email 2.37.2 In-Reply-To: <20221013172918.846856-1-corbet@lwn.net> References: <20221013172918.846856-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" Remove the ancient support for the Sphinx "classic" theme; everybody will have alabaster, so that fallback is no longer needed. While in the neighborhood: get rid of lots of useless comment lines. They describe the state of Sphinx options when we first created that file and are just clutter now. Suggested-by: Mauro Carvalho Chehab Acked-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet --- Documentation/conf.py | 181 +----------------------------------------- 1 file changed, 2 insertions(+), 179 deletions(-) diff --git a/Documentation/conf.py b/Documentation/conf.py index 1dbf3d6a55de..6ab47833ab6c 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -297,7 +297,7 @@ if html_theme =3D=3D 'sphinx_rtd_theme' or html_theme = =3D=3D 'sphinx_rtd_dark_mode': html_css_files.append('theme_rtd_colors.css') =20 except ImportError: - html_theme =3D 'classic' + html_theme =3D 'alabaster' =20 if "DOCS_CSS" in os.environ: css =3D os.environ["DOCS_CSS"].split(" ") @@ -313,36 +313,7 @@ if major <=3D 1 and minor < 8: for l in html_css_files: html_context['css_files'].append('_static/' + l) =20 -if html_theme =3D=3D 'classic': - html_theme_options =3D { - 'rightsidebar': False, - 'stickysidebar': True, - 'collapsiblesidebar': True, - 'externalrefs': False, - - 'footerbgcolor': "white", - 'footertextcolor': "white", - 'sidebarbgcolor': "white", - 'sidebarbtncolor': "black", - 'sidebartextcolor': "black", - 'sidebarlinkcolor': "#686bff", - 'relbarbgcolor': "#133f52", - 'relbartextcolor': "white", - 'relbarlinkcolor': "white", - 'bgcolor': "white", - 'textcolor': "black", - 'headbgcolor': "#f2f2f2", - 'headtextcolor': "#20435c", - 'headlinkcolor': "#c60f0f", - 'linkcolor': "#355f7c", - 'visitedlinkcolor': "#355f7c", - 'codebgcolor': "#3f3f3f", - 'codetextcolor': "white", - - 'bodyfont': "serif", - 'headfont': "sans-serif", - } -else: +if html_theme =3D=3D 'alabaster': html_theme_options =3D { 'description': get_cline_version(), 'font_size': '10pt', @@ -352,44 +323,11 @@ else: =20 sys.stderr.write("Using %s theme\n" % html_theme) =20 -# Theme options are theme-specific and customize the look and feel of a th= eme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options =3D {} - -# Add any paths that contain custom themes here, relative to this director= y. -#html_theme_path =3D [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title =3D None - -# A shorter title for the navigation bar. Default is the same as html_tit= le. -#html_short_title =3D None - -# The name of an image file (relative to this directory) to place at the t= op -# of the sidebar. -#html_logo =3D None - -# The name of an image file (within the static path) to use as favicon of = the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x= 32 -# pixels large. -#html_favicon =3D None - # Add any paths that contain custom static files (such as style sheets) he= re, # relative to this directory. They are copied after the builtin static fil= es, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path =3D ['sphinx-static'] =20 -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path =3D [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bott= om, -# using the given strftime format. -#html_last_updated_fmt =3D '%b %d, %Y' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. html_use_smartypants =3D False @@ -398,50 +336,6 @@ html_use_smartypants =3D False # Note that the RTD theme ignores this 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. -#html_additional_pages =3D {} - -# If false, no module index is generated. -#html_domain_indices =3D True - -# If false, no index is generated. -#html_use_index =3D True - -# If true, the index is split into individual pages for each letter. -#html_split_index =3D False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink =3D True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is = True. -#html_show_sphinx =3D True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is Tru= e. -#html_show_copyright =3D True - -# If true, an OpenSearch description file will be output, and all pages wi= ll -# contain a tag referring to it. The value of this option must be = the -# base URL from which the finished HTML is served. -#html_use_opensearch =3D '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix =3D None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' -#html_search_language =3D 'en' - -# A dictionary with options for the search language support, empty by defa= ult. -# Now only 'ja' uses this config value -#html_search_options =3D {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) = that -# implements a search results scorer. If empty, the default will be used. -#html_search_scorer =3D 'scorer.js' - # Output file base name for HTML help builder. htmlhelp_basename =3D 'TheLinuxKerneldoc' =20 @@ -583,19 +477,6 @@ texinfo_documents =3D [ 'Miscellaneous'), ] =20 -# Documents to append as an appendix to all manuals. -#texinfo_appendices =3D [] - -# If false, no module index is generated. -#texinfo_domain_indices =3D True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls =3D 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu =3D False - - # -- Options for Epub output ---------------------------------------------- =20 # Bibliographic Dublin Core info. @@ -604,67 +485,9 @@ epub_author =3D author epub_publisher =3D author epub_copyright =3D copyright =20 -# The basename for the epub file. It defaults to the project name. -#epub_basename =3D project - -# The HTML theme for the epub output. Since the default themes are not -# optimized for small screen space, using the same theme for HTML and epub -# output is usually not wise. This defaults to 'epub', a theme designed to= save -# visual space. -#epub_theme =3D 'epub' - -# The language of the text. It defaults to the language option -# or 'en' if the language is not set. -#epub_language =3D '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme =3D '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier =3D '' - -# A unique identification for the text. -#epub_uid =3D '' - -# A tuple containing the cover image and cover page html template filename= s. -#epub_cover =3D () - -# A sequence of (type, uri, title) tuples for the guide element of content= .opf. -#epub_guide =3D () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files =3D [] - -# HTML files that should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files =3D [] - # A list of files that should not be packed into the epub file. epub_exclude_files =3D ['search.html'] =20 -# The depth of the table of contents in toc.ncx. -#epub_tocdepth =3D 3 - -# Allow duplicate toc entries. -#epub_tocdup =3D True - -# Choose between 'default' and 'includehidden'. -#epub_tocscope =3D 'default' - -# Fix unsupported image types using the Pillow. -#epub_fix_images =3D False - -# Scale large images. -#epub_max_image_width =3D 0 - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#epub_show_urls =3D 'inline' - -# If false, no index is generated. -#epub_use_index =3D True - #=3D=3D=3D=3D=3D=3D=3D # rst2pdf # --=20 2.37.2