From nobody Tue Apr 7 06:33:38 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 AC8A6C433F5 for ; Tue, 11 Oct 2022 19:01:22 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229659AbiJKTBV (ORCPT ); Tue, 11 Oct 2022 15:01:21 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54614 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229456AbiJKTBD (ORCPT ); Tue, 11 Oct 2022 15:01:03 -0400 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C9C0C82D35; Tue, 11 Oct 2022 12:00:58 -0700 (PDT) Received: from meer.lwn.net (unknown [IPv6:2601:281:8300:73::5f6]) by ms.lwn.net (Postfix) with ESMTPA id 226DB993; Tue, 11 Oct 2022 19:00:58 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 226DB993 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1665514858; bh=HMKtofhzkC0BbHU/AlRiFnMQhJNC5T93PGks81TP6Ho=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=gZKU2oRQgeOpyosrSMLURM/RecqDGoGEyb42A45zag0mSZRQVWxwvLVAJ13FxIrFz hRrQsinG5uh4xTEG9nEXdI+TPRTGrzUUwkpPItMIZOXCsGfVQIWeTfufbqjGqUuEIj l6vpGqYZXftiuDKAc9ZAuDSG8EqTjYYVN+IzgLvSFQ1abd3ScsNALOpcckwVYeSQhs qYp/6VkioMtSBU13zPthYHz1i+zrWHI95x8QNWJFAQQb/WmgrUGb//7kcphUT8GrAF m5Xtyqy4p2ISQVRj5bbRL35BTVQZOk4kFN4hCP/rlipRggGW1vpHyqohWDLrH0hwvj Xc0hQnkU8GPXQ== 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 3/6] docs: update sphinx.rst to reflect the default theme change Date: Tue, 11 Oct 2022 13:00:44 -0600 Message-Id: <20221011190047.749145-4-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" We don't default to Read The Docs anymore; update the docs to match. Signed-off-by: Jonathan Corbet --- Documentation/doc-guide/sphinx.rst | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/s= phinx.rst index 1228b85f6f77..d71e0beb11f3 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -130,11 +130,9 @@ section of ``make help``. The generated documentation = is placed in format-specific subdirectories under ``Documentation/output``. =20 To generate documentation, Sphinx (``sphinx-build``) must obviously be -installed. For prettier HTML output, the Read the Docs Sphinx theme -(``sphinx_rtd_theme``) is used if available. For PDF output you'll also ne= ed -``XeLaTeX`` and ``convert(1)`` from ImageMagick -(https://www.imagemagick.org).\ [#ink]_ -All of these are widely available and packaged in distributions. +installed. For PDF output you'll also need ``XeLaTeX`` and ``convert(1)`` +from ImageMagick (https://www.imagemagick.org).\ [#ink]_ All of these are +widely available and packaged in distributions. =20 To pass extra options to Sphinx, you can use the ``SPHINXOPTS`` make variable. For example, use ``make SPHINXOPTS=3D-v htmldocs`` to get more v= erbose @@ -143,12 +141,8 @@ output. It is also possible to pass an extra DOCS_CSS overlay file, in order to cu= stomize the html layout, by using the ``DOCS_CSS`` make variable. =20 -By default, the build will try to use the Read the Docs sphinx theme: - - https://github.com/readthedocs/sphinx_rtd_theme - -If the theme is not available, it will fall-back to the classic one. - +By default, the "Alabaster" theme is used to build the HTML documentation; +this theme is bundled with Sphinx and need not be installed separately. The Sphinx theme can be overridden by using the ``DOCS_THEME`` make variab= le. =20 There is another make variable ``SPHINXDIRS``, which is useful when test --=20 2.37.2