From patchwork Mon Aug 12 15:04:16 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Hugues KAMBA MPIANA X-Patchwork-Id: 47689 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 9B127C52D7D for ; Mon, 12 Aug 2024 15:04:45 +0000 (UTC) Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web10.48630.1723475080823177606 for ; Mon, 12 Aug 2024 08:04:40 -0700 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: arm.com, ip: 217.140.110.172, mailfrom: hugues.kambampiana@arm.com) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 51165FEC; Mon, 12 Aug 2024 08:05:06 -0700 (PDT) Received: from e129527.arm.com (unknown [10.57.80.78]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id A29633F6A8; Mon, 12 Aug 2024 08:04:39 -0700 (PDT) From: Hugues KAMBA MPIANA To: meta-arm@lists.yoctoproject.org Cc: Hugues Kamba-Mpiana Subject: [PATCH 1/2] arm-bsp/documentation: corstone1000: Deprecation of Sphinx context injection Date: Mon, 12 Aug 2024 16:04:16 +0100 Message-Id: <20240812150417.157272-2-hugues.kambampiana@arm.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240812150417.157272-1-hugues.kambampiana@arm.com> References: <20240812150417.157272-1-hugues.kambampiana@arm.com> 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 ; Mon, 12 Aug 2024 15:04:45 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/meta-arm/message/5961 From: Hugues Kamba-Mpiana Read the Docs will stop defining `html_baseurl` Sphinx configuration, which means that projects will need to define it by themselves to keep the canonical custom domain properly configured. The `READTHEDOCS_CANONICAL_URL` environment variable is used to define `html_baseurl` to keep the previous behavior. Also inject the `READTHEDOCS` variable into the `html_context`. Code fragment taken from the blog post here: https://about.readthedocs.com/blog/2024/07/addons-by-default/ Signed-off-by: Hugues Kamba-Mpiana --- .../documentation/corstone1000/conf.py | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/meta-arm-bsp/documentation/corstone1000/conf.py b/meta-arm-bsp/documentation/corstone1000/conf.py index e9cab633..b932a52c 100644 --- a/meta-arm-bsp/documentation/corstone1000/conf.py +++ b/meta-arm-bsp/documentation/corstone1000/conf.py @@ -10,15 +10,19 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -# import os -# import sys # sys.path.insert(0, os.path.abspath('.')) +import os +import sys + +# Append the documentation directory to the path, so we can import variables +sys.path.append(os.path.dirname(__file__)) + # -- Project information ----------------------------------------------------- project = 'corstone1000' -copyright = '2020-2022, Arm Limited' +copyright = '2020-2024, Arm Limited' author = 'Arm Limited' @@ -46,6 +50,16 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'docs/infra'] # html_theme = 'sphinx_rtd_theme' +# Define the canonical URL if you are using a custom domain on Read the Docs +html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") + +# Tell Jinja2 templates the build is running on Read the Docs +if os.environ.get("READTHEDOCS", "") == "True": + if "html_context" not in globals(): + html_context = {} + html_context["READTHEDOCS"] = True + + # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". From patchwork Mon Aug 12 15:04:17 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Hugues KAMBA MPIANA X-Patchwork-Id: 47688 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 999EDC52D7C for ; Mon, 12 Aug 2024 15:04:45 +0000 (UTC) Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web10.48631.1723475081867718000 for ; Mon, 12 Aug 2024 08:04:42 -0700 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: arm.com, ip: 217.140.110.172, mailfrom: hugues.kambampiana@arm.com) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 5697B106F; Mon, 12 Aug 2024 08:05:07 -0700 (PDT) Received: from e129527.arm.com (unknown [10.57.80.78]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id D40073F6A8; Mon, 12 Aug 2024 08:04:40 -0700 (PDT) From: Hugues KAMBA MPIANA To: meta-arm@lists.yoctoproject.org Cc: Hugues Kamba-Mpiana Subject: [PATCH 2/2] arm-bsp/documentation: corstone1000: Install Sphinx theme as recommended Date: Mon, 12 Aug 2024 16:04:17 +0100 Message-Id: <20240812150417.157272-3-hugues.kambampiana@arm.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240812150417.157272-1-hugues.kambampiana@arm.com> References: <20240812150417.157272-1-hugues.kambampiana@arm.com> 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 ; Mon, 12 Aug 2024 15:04:45 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/meta-arm/message/5962 From: Hugues Kamba-Mpiana Read the Docs recommends installing the Sphinx theme by listing it as an enabled extensions prior to setting it as the active theme. This commit adds it to the enabled extensions list as it was already set as the active theme. Signed-off-by: Hugues Kamba-Mpiana --- meta-arm-bsp/documentation/corstone1000/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/meta-arm-bsp/documentation/corstone1000/conf.py b/meta-arm-bsp/documentation/corstone1000/conf.py index b932a52c..d8b558fa 100644 --- a/meta-arm-bsp/documentation/corstone1000/conf.py +++ b/meta-arm-bsp/documentation/corstone1000/conf.py @@ -32,6 +32,7 @@ author = 'Arm Limited' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx_rtd_theme', ] # Add any paths that contain templates here, relative to this directory.