From patchwork Tue Jul 5 09:42:12 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 9860 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 27372CCA47C for ; Tue, 5 Jul 2022 09:42:47 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web10.82422.1657014165250408412 for ; Tue, 05 Jul 2022 02:42:45 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=none, err=permanent DNS error (domain: 0leil.net, ip: 217.70.183.200, mailfrom: foss+yocto@0leil.net) Received: (Authenticated sender: foss@0leil.net) by mail.gandi.net (Postfix) with ESMTPSA id E26C920003; Tue, 5 Jul 2022 09:42:42 +0000 (UTC) From: Quentin Schulz To: docs@lists.yoctoproject.org Cc: Quentin Schulz , Quentin Schulz Subject: [PATCH 1/2] docs: conf.py: bump minimum Sphinx version requirement Date: Tue, 5 Jul 2022 11:42:12 +0200 Message-Id: <20220705094213.68263-1-foss+yocto@0leil.net> X-Mailer: git-send-email 2.36.1 MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 05 Jul 2022 09:42:47 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3049 From: Quentin Schulz extlinks captions support using %s substitution but only from sphinx 4.0 onwards. Anything before does not support the %s substitution. However, this will be a requirement in sphinx 6.0 and later, and sphinx 5.0 already shows a warning telling us that. Since the build is made with -W flag which fails it if any warning is printed, a fix is required. Sphinx 4.0.0 was released two years ago. Unfortunately, Debian packages are out-of-date and only the latest Ubuntu has recent enough packages. Therefore, pip installation should be recommended now instead and the minimum version for building the docs bumped to 4.0. Cc: Quentin Schulz Signed-off-by: Quentin Schulz --- documentation/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/conf.py b/documentation/conf.py index baf550e3e..8a9cbc972 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -53,7 +53,7 @@ author = 'The Linux Foundation' # -- General configuration --------------------------------------------------- # Prevent building with an outdated version of sphinx -needs_sphinx = "3.1" +needs_sphinx = "4.0" # to load local extension from the folder 'sphinx' sys.path.insert(0, os.path.abspath('sphinx')) From patchwork Tue Jul 5 09:42:13 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 9859 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 26806C433EF for ; Tue, 5 Jul 2022 09:42:47 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web12.82240.1657014165776215949 for ; Tue, 05 Jul 2022 02:42:46 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=none, err=permanent DNS error (domain: 0leil.net, ip: 217.70.183.200, mailfrom: foss+yocto@0leil.net) Received: (Authenticated sender: foss@0leil.net) by mail.gandi.net (Postfix) with ESMTPSA id E172A2000B; Tue, 5 Jul 2022 09:42:43 +0000 (UTC) From: Quentin Schulz To: docs@lists.yoctoproject.org Cc: Quentin Schulz , Quentin Schulz Subject: [PATCH 2/2] Revert "docs: conf.py: fix cve extlinks caption for sphinx <4.0" Date: Tue, 5 Jul 2022 11:42:13 +0200 Message-Id: <20220705094213.68263-2-foss+yocto@0leil.net> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220705094213.68263-1-foss+yocto@0leil.net> References: <20220705094213.68263-1-foss+yocto@0leil.net> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 05 Jul 2022 09:42:47 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3050 From: Quentin Schulz This reverts commit c9922076f5c1285d9cfd6aff8ce5b6635d88222f. Since the minimum version required to build the docs has been bumped in the previous commit to 4.0, this commit is not required. Moreover, since Sphinx 5.0 triggers a warning when extlinks captions are not using %s substitution and Sphinx 6.0 will fail to build without the substitution characters, this revert is now required to be able to build the docs. Cc: Quentin Schulz Signed-off-by: Quentin Schulz --- documentation/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/conf.py b/documentation/conf.py index 8a9cbc972..2a017569f 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -90,7 +90,7 @@ rst_prolog = """ # external links and substitutions extlinks = { - 'cve': ('https://nvd.nist.gov/vuln/detail/CVE-%s', 'CVE-'), + 'cve': ('https://nvd.nist.gov/vuln/detail/CVE-%s', 'CVE-%s'), 'yocto_home': ('https://www.yoctoproject.org%s', None), 'yocto_wiki': ('https://wiki.yoctoproject.org/wiki%s', None), 'yocto_dl': ('https://downloads.yoctoproject.org%s', None),