From: ross.burton@arm.com
To: meta-arm@lists.yoctoproject.org
Subject: [PATCH] arm-bsp/documentation: upgrade Sphinx slightly
Date: Mon, 15 Jan 2024 20:28:21 +0000 [thread overview]
Message-ID: <20240115202821.995840-1-ross.burton@arm.com> (raw)
From: Ross Burton <ross.burton@arm.com>
Many Sphinx plugins now require Sphinx 5+ ([1], [2], and more), so
sphinx 4.5 isn't usable as the requirements in sphinx itself are not
pinned so you end up with a broken setup with errors such as:
sphinx.errors.VersionRequirementError: The sphinxcontrib.serializinghtml
extension used by this project needs at least Sphinx v5.0; it therefore
cannot be built with this version.
There's a sufficient number of plugins that manually pinning them all is
tedious, so upgrade the documentation to Sphinx 5 (and the corresponding
RTD theme).
Also remove sphinx-copybutton, as this extension is unused.
[1] https://github.com/sphinx-doc/sphinxcontrib-applehelp/commit/ccc77c814a92ef21c300e5ef725b76c40b7ce653
[2] https://github.com/sphinx-doc/sphinxcontrib-devhelp/commit/b2dc14bd8bdd7994c565d254772a0ba3ddecfe51
Signed-off-by: Ross Burton <ross.burton@arm.com>
---
meta-arm-bsp/documentation/requirements.txt | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/meta-arm-bsp/documentation/requirements.txt b/meta-arm-bsp/documentation/requirements.txt
index b82e5e07..6b4e3bb2 100644
--- a/meta-arm-bsp/documentation/requirements.txt
+++ b/meta-arm-bsp/documentation/requirements.txt
@@ -6,7 +6,6 @@
jinja2==3.1.1
# Required to build the documentation
-sphinx==4.5.0
-sphinx_rtd_theme==1.0.0
-sphinx-copybutton==0.5.0
+sphinx~=5.0
+sphinx_rtd_theme~=2.0.0
docutils==0.17.1
--
2.34.1
next reply other threads:[~2024-01-15 20:28 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-15 20:28 ross.burton [this message]
2024-01-16 14:54 ` [PATCH] arm-bsp/documentation: upgrade Sphinx slightly Jon Mason
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240115202821.995840-1-ross.burton@arm.com \
--to=ross.burton@arm.com \
--cc=meta-arm@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).