From patchwork Wed Nov 6 07:48:23 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 52082 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 12C41D29FB1 for ; Wed, 6 Nov 2024 07:48:55 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web11.40794.1730879325380401546 for ; Tue, 05 Nov 2024 23:48:45 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=fkou3Avv; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 8BDC2FF805; Wed, 6 Nov 2024 07:48:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1730879323; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Lqx39oGGj96lrf/l1G9vxDpfCr/Lorricv0rhMt0qYI=; b=fkou3AvvNNuA0Vkku+wSlehJNXWQ6woZBR7VjCdTVW1Y4hWZwExLxece46TSBtGfadKc88 U3KfAN3gM5viU7huttG/Owt28uYNkMTdApyG2mnlBj0AyxYZIoEZDDDGhomR9AXGiS5emG Frwf5Ht+cN1j98RYqNrId9GwMD8a+19GJHqjuQBdjtzm3QsU4PM/NxttEg/zvJ087e9Jph HgwlmMm/xrS+7tXs9KTXkx5GQLTB865UVE5Jw9MCB5sslqntwCE2pWhBeEg08V1C9Ywi/S ouZtjtdYqKll1oZStwB7W0qPuMBBF7wZRLfi1wEqT4BYGbV3WhRILzQqPvcrIQ== From: Antonin Godard Date: Wed, 06 Nov 2024 08:48:23 +0100 Subject: [PATCH 1/5] doc: Makefile: remove inkscape, replace by rsvg-convert MIME-Version: 1.0 Message-Id: <20241106-pdf-xetex-v1-1-044eab7e77d3@bootlin.com> References: <20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com> In-Reply-To: <20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Richard Purdie , Antonin Godard X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1423; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=Pqv6ryg0XyhhzfHm7j3qPI/tbK8xVykjngpk2jhkMls=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBnKx9afLaHoS60+DLx2Qk13CfVpZP0rf6WLgVLQ gF3IrDI38uJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZysfWgAKCRDRgEFAKaOo Ni6sD/9ON/jiFwfQaERORcL/Ob2OjaOqskIUNgEo+apGq3H9XckGxYfUdPpOQVgjTOFTLQ/mHzT DniQYZRb7gmv7T+8ebKj61hwZlp3Z0LBv8Xhm64IMY5HRhmN8E/UtPfQAp7KihNDvhfcb/7IozM XVsk6njonTc+XqWoFcs+SXSSk3AYHcz9T5oEeZg+CRb6Y17rQCezb45mYepmDnwIMTIFpyARFpR CLGdBEIbW9rybSHxkVe6mfC/lavLNQaE0PWdTOqasHSW2B7wSAUsxCj6RVzTe/CVksB7e6mSai3 iBwPPHkGUNVNMiyEqdWhhNZXFUqMrwBCgxrB7FCeQ3WB/9jimJSSYXGFxNAEMudlxQ+4G1Y/iom dwWevHhqnAOfoKH0D4ZCkeSTW0Wd142Yo6FwhkF8TvVJ9T/44DMHLxeBWWuK2EnDCSwvfuAuXx1 avWlU/VJIROMIIC2nf4/H1vdTjoIAd3A+jeLg00/Pn6UCjplKqa16OMIr5NFNVlq9cmT1xKRxv9 vSiTLD1zxS11fpZUvHBSEzhKIKfSC7/KW7yt6ez7nAxric9W2kXetu2Og9sJgYP6wFvNB/8yvta 5XWWNK2UUZKWVzuQC7npsfFgqzHm/hTZR/+rElgsZGGRThVutLJOsMw4/OcC+BXs7LdxNxlxJ53 p1sm0dgmAfPnruQ== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-Sasl: antonin.godard@bootlin.com 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 ; Wed, 06 Nov 2024 07:48:55 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5687 Remove inkscape as it is not part of meta/, and use librsvg so we can ship it in a buildtools tarball for the autobuilder workers. Signed-off-by: Antonin Godard --- documentation/Makefile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index 189bd1dfac69d3b3185aa3a2ff7c212084ae280b..d0333de2cb84ba648a64e51fd3711113788d6714 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -12,8 +12,8 @@ SOURCEDIR = . IMAGEDIRS = */svg BUILDDIR = _build DESTDIR = final -SVG2PNG = inkscape -SVG2PDF = inkscape +SVG2PNG = rsvg-convert +SVG2PDF = rsvg-convert ifeq ($(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi),0) $(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed") @@ -40,11 +40,11 @@ PNGs := $(foreach dir, $(IMAGEDIRS), $(patsubst %.svg,%.png,$(wildcard $(SOURCED # Pattern rule for converting SVG to PDF %.pdf : %.svg - $(SVG2PDF) --export-filename=$@ $< + $(SVG2PDF) --format=Pdf --output=$@ $< # Pattern rule for converting SVG to PNG %.png : %.svg - $(SVG2PNG) --export-filename=$@ $< + $(SVG2PNG) --format=Png --output=$@ $< clean: @rm -rf $(BUILDDIR) $(PNGs) $(PDFs) poky.yaml sphinx-static/switchers.js releases.rst From patchwork Wed Nov 6 07:48:24 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 52081 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 0A270D29FB5 for ; Wed, 6 Nov 2024 07:48:55 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web11.40793.1730879325377202811 for ; Tue, 05 Nov 2024 23:48:45 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=dGVKJkEN; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id CBDC2FF80D; Wed, 6 Nov 2024 07:48:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1730879324; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=u/lXnvows4YXgYQbcE4aZ7HpxCFGYGU7eNJtjt0SyRM=; b=dGVKJkENb2aNahpcRgQgwfRQpZ9NAwO/qrVt14dy4uftuBW8SxfEe8qE9xfU7od7bNDI06 B8y8VegbGZ4HcOCqKOWlzjzSCfbAJT2+bgHaeyHkQ2Dnnz+ucA+BtQY20eAqdDD9ghprqH rpNHA6PgHmvaAd3/bY7GyKGNLpO4GxfrpRkJb+nu+IC7xaye81slr1h45ROonXrFa06Myx dfgYb+tdz7KXOg6PEjeJ/1twzdgVM/8JoGWUFjxpHLYF7docefa3Lqwcf+RLfwZFpss3xL ebi/EeGq9P8NWStx7mw7Buide2Bomi0wcN8K9OSPrZ06Uczzafz6rjza7O3y8A== From: Antonin Godard Date: Wed, 06 Nov 2024 08:48:24 +0100 Subject: [PATCH 2/5] doc: Makefile: add support for xelatex MIME-Version: 1.0 Message-Id: <20241106-pdf-xetex-v1-2-044eab7e77d3@bootlin.com> References: <20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com> In-Reply-To: <20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Richard Purdie , Antonin Godard X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=2339; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=0l16od1Wyl5VScPl8WdDgP3rKKU3Hk+COU5jleK1/XQ=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBnKx9a4dbkPUroOy7ejlaJeTKLasPuasOg/NsSg seJxSvAzo+JAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZysfWgAKCRDRgEFAKaOo NkZbD/498Bmv/hPJi8eC/D+9Je9OCC/RpAoWL1IRZu1cZWLTmzOEml06rm2OqVOs4k5KSMpFHnt /SdvFrti8Z/GXUDqoqor5xAcw7MeHDcdn4YcK1wPuvyV2+NEfTN5cerMFrn/4ABOOS2lrUkxwQE FeCuSGoSMdq6g1bitFFmHhl871OtVQ5nnhlJnBg3p30ueqE8oIaCV5dxrprNBuVM83B+u5qYQ+Z VrLuNiJqZ4LHljgdfBOsVWKPxDA3yQGesenKkKn15V9SyRR8kvTfi1lLxQl+elqQNBy9/8ODuqJ v5svVu0qTFT+jQ3fDAxCZbs3b//6+JY7rC28FaoOJ5QrXO0jwbxDl5Zg40yYda7fKZupUR9TGpT pculz7YYC6MigaMhWG4yW0Di1jkIxTzuwodhZMf7da+QUY8OAIU3ioTj0xV3X1ebNc3dBhEwGgT iJtL8RHWgYbEoPl83DiKbG+SBQTAqG0af6c3faAJ32CtR/nc6JpilK7yBnarE3MGaAXR2ss1Lk2 LfHcmHhjzcQ4x/V0+yFjm1054UzqvToq+4JDOS/GrL+xEuRBu/IrEqdd+dW8YRLNznBgPg2RE6f /F9yqmrRiBP4vAv8t2CzcV3e1wix/9Sc7aV/Gbgn6P3wej4GnhjHZolfRnGf+CjHdU4TN646efe ZcDpAgMwHRt+NUA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-Sasl: antonin.godard@bootlin.com 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 ; Wed, 06 Nov 2024 07:48:55 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5686 This patch makes the "latexpdf" target compile the documentation with xelatex instead of the default pdflatex engine. The reason behind this is stated in [YOCTO #14357]: pdflatex does not support compiling foreign characters, so we need to resort to another engine, here xelatex. It also increases the texmf config buf_size to 10000000 to avoid a compilation error. Signed-off-by: Antonin Godard --- documentation/Makefile | 5 ++++- documentation/conf.py | 7 ++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index d0333de2cb84ba648a64e51fd3711113788d6714..12ca2f95f6578a31cd309f80b58a2702561a6b9f 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -60,9 +60,12 @@ epub: $(PNGs) $(SOURCEDIR)/set_versions.py @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) +# Note: we need to pass buf_size here (which is also configurable from +# texmf.cnf), to avoid following error: +# Unable to read an entire line---bufsize=200000. Please increase buf_size in texmf.cnf. latexpdf: $(PDFs) $(SOURCEDIR)/set_versions.py - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + buf_size=10000000 $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) all: html epub latexpdf diff --git a/documentation/conf.py b/documentation/conf.py index 9e87df0564c1e93140bce8705d9b45f75cbded58..c7dd4e03fc0e99176a0fa2f74fda58efaf0af9b2 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -158,9 +158,14 @@ html_last_updated_fmt = '%b %d, %Y' # Remove the trailing 'dot' in section numbers html_secnumber_suffix = " " +# We need XeTeX to process special unicode character, sometimes the contributor +# list from the release note contains those. +# See https://docs.readthedocs.io/en/stable/guides/pdf-non-ascii-languages.html. +latex_engine = 'xelatex' +latex_use_xindy = False latex_elements = { 'passoptionstopackages': '\\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', - 'preamble': '\\setcounter{tocdepth}{2}', + 'preamble': '\\usepackage[UTF8]{ctex}\n\\setcounter{tocdepth}{2}', } # Make the EPUB builder prefer PNG to SVG because of issues rendering Inkscape SVG From patchwork Wed Nov 6 07:48:25 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 52083 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 1A2E6D29FB6 for ; Wed, 6 Nov 2024 07:48:55 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web11.40795.1730879325706011646 for ; Tue, 05 Nov 2024 23:48:46 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=CFExs51e; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 1860EFF80E; Wed, 6 Nov 2024 07:48:44 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1730879324; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=6GKJJpTJ0DiH71XVYj1QwbiqEA0lC0JN755CVdfTa7Q=; b=CFExs51e9cT4y3V+KMXpanr0YSCg8XQwBwDZjSv8UidVbCwYEKSD1CpZ5sAXQGnsBXXtyO ztQf37WCRUEoMrhd852NXWn23p0/Wr2v+CKyKXH1cxr3UXcGA+J6w6saJplNt20Rvrvymx rRRd3j1BUujSgTVJixPyoaP1otqmRuyu9/9mKP+YdWU9OwPWGmHzS/DYhiE284YvPwBiPv +NghxL1mtnlKIufjxCVIcITpWLu/77SLO7BrEY7H6oMc9LNvbVFDxjNjmxhBFsIBUgSiE2 eogvO8dSgYuTMDUPoBkH2LA13yYsKIIh2jdpX57hEUMwdJRnpZmefnyKTDaMNA== From: antonin.godard@bootlin.com Date: Wed, 06 Nov 2024 08:48:25 +0100 Subject: [PATCH 3/5] doc: Makefile: publish pdf and epub versions too MIME-Version: 1.0 Message-Id: <20241106-pdf-xetex-v1-3-044eab7e77d3@bootlin.com> References: <20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com> In-Reply-To: <20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Richard Purdie , Antonin Godard , Michael Opdenacker X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1175; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=IL2nKlHd0vwnIuLZg+S0roYIBzd1gWx17CBUOPThIE0=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBnKx9aIPsZJdNq9o+GBZBmY+hHpRvBoosEw3hyZ bh87Zbmf6WJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZysfWgAKCRDRgEFAKaOo NjcyD/9np7XxmcE0jwQKdabdkIuvnz3F9QT567NSQgT4c+eRxYHsZJqg43E9hbE2dlz8jcpBajA QTr+Gp2LaPtu/yRHbVDrS7TEU8XgrKX9eshZGjv2DHic/CwmT8Y9hLgEj3NPt2Q7G5SUM1olwtl c0C1pnq6JhQ5s7DmB4DZV1ZCOUaZhpKH1nrLH5R7nK5AUg3EDSj2GDMtADSVbKR/tWlOUj9bICP dztbu4UvGWciuiLDOPlxZZ8VhgKCA+jDrK9DkNUg99ZeHJSFicLAYRsaniNFe1hk4tqpHY4BcQF dcTQmKCK8eAUqE89KjAyfsY+ephfw4RBb06tzkPGRyjdP9UAIE/X6RH0DLgaSRUprirgZwy2Pwu Bb44qLGElm08RbJGdG7JSrZzD5xgK2aBJEs5rqr6YdnZYxK4oYLaseV63Axu/2d1UoqIoVV7CQU X89mEgh+yPWmSBSnNEur5xuzK1OCZ/MiJDkRSa3WGU/t6IDMhoy6FzDfSk/Pb5QGNuA8mbU8Mcz XBDPLnMUaerohXIb52dNL/ZicHGrumrM2AJYHIALYMU88YR60m7gJYG7fuE8PtcSZ6ZUkopuf8c TjnhfjMRIIKgH/pqVFltz8A5LGKJhM1FNzwj4H38w9P/UdLpZtbHSaWfE9iVZlOgrKgMDwS4EiE qMgP+LvS3/m2a+g== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-Sasl: antonin.godard@bootlin.com 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 ; Wed, 06 Nov 2024 07:48:55 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5688 From: Michael Opdenacker Copy the generated files in the special _static directory. Fixes [YOCTO #14357] Signed-off-by: Michael Opdenacker Signed-off-by: Antonin Godard --- documentation/Makefile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/Makefile b/documentation/Makefile index 12ca2f95f6578a31cd309f80b58a2702561a6b9f..ef5a6ce33987e8a79a65ac400212f877b7daf11e 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -25,10 +25,12 @@ help: .PHONY: all help Makefile clean stylecheck publish epub latexpdf -publish: Makefile html singlehtml +publish: Makefile epub latexpdf html singlehtml rm -rf $(BUILDDIR)/$(DESTDIR)/ mkdir -p $(BUILDDIR)/$(DESTDIR)/ cp -r $(BUILDDIR)/html/* $(BUILDDIR)/$(DESTDIR)/ + mkdir -p $(BUILDDIR)/$(DESTDIR)/_static + cp $(BUILDDIR)/epub/TheYoctoProject.epub $(BUILDDIR)/latex/theyoctoproject.pdf $(BUILDDIR)/$(DESTDIR)/_static/ cp $(BUILDDIR)/singlehtml/index.html $(BUILDDIR)/$(DESTDIR)/singleindex.html sed -i -e 's@index.html#@singleindex.html#@g' $(BUILDDIR)/$(DESTDIR)/singleindex.html From patchwork Wed Nov 6 07:48:26 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 52085 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 27564D29FBC for ; Wed, 6 Nov 2024 07:48:55 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web11.40796.1730879325981221365 for ; Tue, 05 Nov 2024 23:48:46 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=IfKYiRKu; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 600F0FF810; Wed, 6 Nov 2024 07:48:44 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1730879324; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=6odvHeEccHqPazOUZqUfbkumvKTfmUAh7IBuO83e5S8=; b=IfKYiRKuVDjEqQ/NTXvgSubarQa3SxDEtCb267yBEHrhvaXmMlwLSoNy02R3e0zZYA4xS/ 9/cx4WCrYVU296bG9cF7hboweBomDhQWfvbln5/Su+1jc9XbU3dMDW5r4Zw3ogJL3gHheS B0MMXSxHByJO0gCJ7XufIOjTduN/d/gTrfEG2Syq9zVQpfbSyd/19dejw9mLJHg5JwwdqY Wa11oJDAfPgHfo0z3MlYP4XaiCVLBxIgNX8pQDogvyrtui4mtayV8ozI+jn9/b/7Mplr/b B+IvssT0zMYXtQ0kjFoZ9SobzsewDpMDFEx3NzZfBpCIIope7urwbU4TYeVS1g== From: Antonin Godard Date: Wed, 06 Nov 2024 08:48:26 +0100 Subject: [PATCH 4/5] doc: add a download page for epub and pdf MIME-Version: 1.0 Message-Id: <20241106-pdf-xetex-v1-4-044eab7e77d3@bootlin.com> References: <20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com> In-Reply-To: <20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Richard Purdie , Antonin Godard X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1492; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=t52IMbOEq7R+9/cO3fNGzOUg+1ltuQwfTeNvG85FJA0=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBnKx9akaP6r8IbP+ywNr5ltX1pyLTwv1zNBWy5V 79krAgdbKCJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZysfWgAKCRDRgEFAKaOo NnBeEACgY31G2tAbUmg4XQHMmUZF1iCzQLV+tWrdfJJNcm4EF23S0G2qVKYm8C/1y6FY8NHOYl2 9KkPppwQE/5VccLS0odEt4krZ6rv3dX6UKf9F776sN7KE/VBW5+IgKm6iMSZZCscYATAZWPkVla xJ2znXTgbtiKPsCWDkIzifO4i2gkrQfF1182nNEdxZuFaHE85vy9qBoiE0JOWrzYgXkE9tPp9vn r6jbwMCNaxUWkESkQlNP/UqdfqL92NgWhA78kRqOkWTxn6SxrnFxQiRq+PUHljLkwoqDGeyFssz oBNM3xnnN0SggdJErFjQnnBeZAbqBbrputOtxUyEoCpZ8/98i6gYTnFODnWq+TV8hRP5YbzI+C9 hbKs7KTXjFpJ0P64bpfjBCkb0HUU6mTcegNyTZSQJkQGQUFyXg1DKFAWfpFl1KtsPrSXIztK+Kf 7mFtFvcIki10zkNgIL+pjdkxTLfkXLwib3y6j12AuXDme1IS686H6slbivM07farVBij8CHo+E4 CBCxBOd3I5kYeD4mJUI+UBVQizPFVxKDSpTBcsU0ssu2L7MmIMUAq3ZqFwDkUm54YvdviBSF32L KOCwqSugUIEC7+N0T24ajP87/MPL4RNvFNgtW+SLD8yYuEHwCebNaiMeMUgkeAySIzufQYc/Gao sdEmIiOgYejCCOA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-Sasl: antonin.godard@bootlin.com 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 ; Wed, 06 Nov 2024 07:48:55 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5689 These files are placed in the _static directory during publish. Note that Sphinx does not complain if files do not exist during compilation (since they are copied at the end). This is why this was used instead of the ":download:" role. Signed-off-by: Antonin Godard --- documentation/downloads.rst | 11 +++++++++++ documentation/index.rst | 7 +++++++ 2 files changed, 18 insertions(+) diff --git a/documentation/downloads.rst b/documentation/downloads.rst new file mode 100644 index 0000000000000000000000000000000000000000..7ec978ef2da80c33f4e3b2aab47320ef01973187 --- /dev/null +++ b/documentation/downloads.rst @@ -0,0 +1,11 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +======================= +Documentation Downloads +======================= + +The documentation can be downloaded in file formats to be read offline or on +another device. The currently supported formats are linked below: + +- `EPub <_static/TheYoctoProject.epub>`_ +- `PDF <_static/theyoctoproject.pdf>`_ diff --git a/documentation/index.rst b/documentation/index.rst index 3fef1704a481da9e5e4c697a8efa995525ae5e6a..6c6be38a7e8c46bcc910d14abdc18f78b200c399 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -51,3 +51,10 @@ Welcome to the Yocto Project Documentation :hidden: genindex + +.. toctree:: + :maxdepth: 1 + :caption: Documentation Downloads + :hidden: + + downloads From patchwork Wed Nov 6 07:48:27 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 52084 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 25F96D29FB8 for ; Wed, 6 Nov 2024 07:48:55 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web10.40952.1730879326234660483 for ; Tue, 05 Nov 2024 23:48:46 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=MdNr+5wJ; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 9FC57FF812; Wed, 6 Nov 2024 07:48:44 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1730879324; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=SZUQ9TdDZ2hrpecaB7r3rG4NAoZERhsy8me1AGx8s/M=; b=MdNr+5wJvacxbWh0mVSqxhURCtOhTUVG/tsYC+tbnAFJVsb4bD7PgXBburb4NmXYY/qMkt LaPvYSkMKCuKKufzUATOchL0/ircUKGKM40Bh2FWyMxqqWnTNjsu8Jde2uNmGV/P4emsfE iNuEMDDp5Ntr9HmW9BySN/08WgpVgwUofuuqPLJvcfE5/lK/nzd9toFEtWecnGOky+3Mjh O4Tx0N6J8XC3Y6B1II5FeJqEAznFHcrR9B5GryjdrO2OHyYUC0zyyUPScU2ZoUy9h68Q3u fSj29L0UY/mDdtk5ux5eq+koxHcPw9RcG99FtDNVUumkABUzVS2gPCeZ0hSGfA== From: Antonin Godard Date: Wed, 06 Nov 2024 08:48:27 +0100 Subject: [PATCH 5/5] sphinx-static/switchers.js.in: do not refer to URL_ROOT anymore MIME-Version: 1.0 Message-Id: <20241106-pdf-xetex-v1-5-044eab7e77d3@bootlin.com> References: <20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com> In-Reply-To: <20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Richard Purdie , Antonin Godard X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1404; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=y/rIEkrRil314mOgCj4Y3usRFzdTad1jya7AtOkpRao=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBnKx9a/vbI9QGKc2BFhcPvrQLbg7vG1sy+G5vod LLdGU62d/yJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZysfWgAKCRDRgEFAKaOo Nr1WD/9KNQrMhNSzF4cnRvVGLm4NgRmJi39OKbtsNBvTPEFUyYWwx9UglrhpfC9ZaUfKSpoYU3J kevPAT8iDXSB7dK8r1cSd47yNWzwc2vn90E4+WKpBqNABuugE+FBXYEyjL+lWI0ksbwOmcRJZMM C+HajQaALzGzW0J04sg8/Jcm+dP7PiSlmy++7Un0P5b+hp8Q36Ij7mppK642WCoVNlSSWMDjydd 3l5hXMImDus/C/fZtRn2j8gf7QUZfBzauRSGMYnwmAj6ghmArKqCJG9SVjDiW7w/znFf86L2a1P DPww0si9rUsPna/9+zAdBVeaTPg7ufsjHeq89JuxgfCw4iMJuE7oB1q3yZAzu8Zulnl5/p6nlB4 +7LTEqswEScYm10s1yqD1FGUlH0ESmCLfYNP5A6VE+kRHxyGsdsCuzorfPDw9NUfNAE1zP/XXeU kE48+Le31AVEobrvL4ue4qhHJMr0fxmK73EEecvQGINowEyJaF7NA+nR3DQLP+YRfpRtcBqEZEd vVka3dFVVit7PeJ4Qg3l1MsDVedG3YXzTVg0ImnKWO82BnDIUULQbu7BWfoQ3k8bkUSpOQZDiZz 9WEtiKd/E8YId6tfWk2Ehyt/OfA1PZN7gYLFXK48pkZh4jIKV4gbHB/3xn/eYcXNNw5xQaAvLrW a/Nr26BmDTOxUgA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-Sasl: antonin.godard@bootlin.com 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 ; Wed, 06 Nov 2024 07:48:55 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5690 This variable was removed from the Sphinx-generated documentation_options.js, thus breaking the current implementation of our switchers.js. Like searchtools.js, which is also generated by Sphinx, use document.documentElement.dataset.content_root as a replacement. To be backwards-compatible to get one or the other. Signed-off-by: Antonin Godard --- documentation/sphinx-static/switchers.js.in | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/documentation/sphinx-static/switchers.js.in b/documentation/sphinx-static/switchers.js.in index 8c016859bc80f03a6322bbea516864f75185c05a..b1c0812b53369b3c635e3466d84ca02f916d34f8 100644 --- a/documentation/sphinx-static/switchers.js.in +++ b/documentation/sphinx-static/switchers.js.in @@ -133,7 +133,13 @@ by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-b function get_docroot_url() { var url = window.location.href; + // Try to get the variable from documentation_options.js var root = DOCUMENTATION_OPTIONS.URL_ROOT; + if (root == null) { + // In recent versions of Sphinx, URL_ROOT was removed from + // documentation_options.js, so get it like searchtools.js does. + root = document.documentElement.dataset.content_root; + } var urlarray = url.split('/'); // Trim off anything after '/'