diff mbox series

arm-bsp/documentation: upgrade Sphinx slightly

Message ID 20240115202821.995840-1-ross.burton@arm.com
State New
Headers show
Series arm-bsp/documentation: upgrade Sphinx slightly | expand

Commit Message

Ross Burton Jan. 15, 2024, 8:28 p.m. UTC 
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(-)

Comments

Jon Mason Jan. 16, 2024, 2:54 p.m. UTC | #1 
On Mon, 15 Jan 2024 20:28:21 +0000, ross.burton@arm.com wrote:
> 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.
> 
> [...]

Applied, thanks!

[1/1] arm-bsp/documentation: upgrade Sphinx slightly
      commit: 83df70e181795ef36ce2605f11b4452960517574

Best regards,
diff mbox series

Patch

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