Received: by 2002:a05:6358:4e97:b0:b3:742d:4702 with SMTP id ce23csp750008rwb; Thu, 18 Aug 2022 11:30:24 -0700 (PDT) X-Google-Smtp-Source: AA6agR78/gcHcL82MSp+sOrZTjocjNnGUuR+roio01RWuziKPENAZdIql5GzgC63TRxlI9DCvPKs X-Received: by 2002:a17:90b:350a:b0:1f5:6a5e:5d12 with SMTP id ls10-20020a17090b350a00b001f56a5e5d12mr10078870pjb.46.1660847424397; Thu, 18 Aug 2022 11:30:24 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1660847424; cv=none; d=google.com; s=arc-20160816; b=YlGNuHtTjWHNiFTLzR+mIBNanqX808brCqHaMmB8b92bKx+YCqpyJXchmpljxwM4V8 lyiOv7npNCXiiyfwKEZOxviO61OFZXaoA6YsTLw+Qj6GDUi5cG7qBYbigFSc/UNIl0Sh aKQeDfGFUz+Amn7DabkPgURKEOu6nKh88nBwxQm9sNJaz7bLBl8Aeb5qzcXCB3xARRld qdkJaOSYJy7Hx+jY3CEv5ccnshpV4b7Ll23d6oeUCA9bGR2eS/Pn4XAleSjlt8hE2gpH BJZows6TVtbybjn97WHNPRV6iDOopJLMGcfSdVrC/qgq3cde/VFhRFEoc7YgukSPIb0o u/+w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:mime-version:message-id:date:references :in-reply-to:subject:cc:to:from:dkim-signature:dkim-filter; bh=3fRl1j7mKGqvV85JpGfgS3kDrE8+2lAy6KIi73rzFoc=; b=bswJ8l5skphN4Gwvm08Ac5vq/DJj7xmksy4poPXX4BbQxXPXctIN6ERmfkBuTO+4MS njMkEOfVfMiDTSFisgTMNgtZ8EaMdnCtT/EOZdXQewpP2Uat5Ca4wTHwb9nKk74BiF/i lLWpeorh0bjhiZ6N+dAl4N1fqjnviEjDT0LG2Nkt4TxdHlsWV1tWjGJCLjrFdl8RmD5U AqWH4ee252r317D+tQa60rV3FVvgP4RHea6nfS0pLlJdDmEQOLfdvdzjI7GiR8eu6LcC e32aOHG+QhPeu5oGR+y4qjcJYeitrh/ZsBtsxl3l3JnPL4WK/xQtwJpv8OnCllTqEsRf BBeQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@lwn.net header.s=20201203 header.b=iKpMyJv3; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id p41-20020a056a000a2900b0052bfb712a60si1905606pfh.328.2022.08.18.11.30.13; Thu, 18 Aug 2022 11:30:24 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@lwn.net header.s=20201203 header.b=iKpMyJv3; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1344438AbiHRR0C (ORCPT + 99 others); Thu, 18 Aug 2022 13:26:02 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58574 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1343515AbiHRRZJ (ORCPT ); Thu, 18 Aug 2022 13:25:09 -0400 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7ED50558E9; Thu, 18 Aug 2022 10:24:50 -0700 (PDT) Received: from localhost (unknown [IPv6:2601:281:8300:73:8b7:7001:c8aa:b65f]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 25B6D380; Thu, 18 Aug 2022 17:24:50 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 25B6D380 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1660843490; bh=3fRl1j7mKGqvV85JpGfgS3kDrE8+2lAy6KIi73rzFoc=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=iKpMyJv3NbbL+LzdhHbx+QU4/u2VBzyekTAjUdJXeQ/8Bq1mmUsx2422T89+X385k XteDu3N47gDwd9r01p8gfH7FJ/nnmNQ7StQXjcVMIMIKJ732E+MxDQSmUE9Px49UEr TqIGxs//RbN3zGVa4hN/pjZfjYMkrDuLUqldcsiAfNz3fIpSJ/bp5RCGF6ITjf/cd4 mhTQnE4EZVT1ZHx1H9LJCMws7Uoe4oqL6seOBmvp9B2N+IOvoDKOZiBitRLH56sbQ1 WR6WNf4CzI+C6VP31CWSeWxIx7GPhLS66aR3ZDlx3iQhME8vpOStFbeV9VZUOJD37Z yN7UUb052ts+Q== From: Jonathan Corbet To: Akira Yokosawa , Mauro Carvalho Chehab Cc: linux-doc@vger.kernel.org, Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Akira Yokosawa Subject: Re: [PATCH v2 2/3] docs/conf.py: Respect env variable SPHINX_IMGMATH In-Reply-To: <736e39fd-b068-80dd-b383-70e061e71bf5@gmail.com> References: <736e39fd-b068-80dd-b383-70e061e71bf5@gmail.com> Date: Thu, 18 Aug 2022 11:24:49 -0600 Message-ID: <87sfltbh26.fsf@meer.lwn.net> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Akira Yokosawa writes: > On some distros with coarse-grained packaging policy, dvipng is > installed along with latex. In such cases, math rendering will > use imgmath by default. It is possible to override the choice by > specifying the option string of "-D html_math_renderer='mathjax'" > to sphinx-build (Sphinx >= 1.8). > > To provide developers an easier-to-use knob, add code for an env > variable "SPHINX_IMGMATH" which overrides the automatic choice > of math renderer for html docs. > > SPHINX_IMGMATH=yes : Load imgmath even if dvipng is not found > SPHINX_IMGMATH=no : Don't load imgmath (fall back to mathjax) > > Signed-off-by: Akira Yokosawa > Acked-by: Mauro Carvalho Chehab > --- > Changes since v1: > - No logical changes. > - Renames: > LOAD_IMGMATH -> SPHINX_IMGMATH (Mauro), > opt_load_imgmath -> env_sphinx_imgmath. > - Acked-by from Mauro. > > -- > Documentation/conf.py | 16 ++++++++++++++-- > 1 file changed, 14 insertions(+), 2 deletions(-) > > diff --git a/Documentation/conf.py b/Documentation/conf.py > index 3ec1f845c839..0b8f20e8e22c 100644 > --- a/Documentation/conf.py > +++ b/Documentation/conf.py > @@ -128,8 +128,20 @@ autosectionlabel_maxdepth = 2 > # mathjax is the default math renderer since Sphinx 1.8. > have_latex = have_command('latex', '--version', 'pdfTeX') > have_dvipng = have_command('dvipng', '--version', 'dvipng') > -load_imgmath = ((have_latex and have_dvipng) > - or (major == 1 and minor < 8) > +load_imgmath = have_latex and have_dvipng > + > +# Respect SPHINX_IMGMATH (for html docs only) > +if 'SPHINX_IMGMATH' in os.environ: > + env_sphinx_imgmath = os.environ['SPHINX_IMGMATH'] > + if 'yes' in env_sphinx_imgmath: > + load_imgmath = True > + elif 'no' in env_sphinx_imgmath: > + load_imgmath = False > + else: # otherwide, auto selection > + pass That "else: pass" sequence does nothing, of course, and could be taken out. Otherwise fine, jon