Skip to contentSkip to conversation

docs: Set upper limit of docutils (<0.17)

PATCH New Akira Yokosawa 3 participants 4 messages Jul 27, 2021 – Aug 12, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: Set upper limit of docutils (<0.17)

sphinx_rtd_theme 0.5.2 has "docutils<0.17" in its requirements. docutils 0.17 was released this April and caused regression in sphinx_rtd_theme 0.5.1 [1].
Put the same limit in sphinx/requirements.txt.

[1]: https://github.com/readthedocs/sphinx_rtd_theme/issues/1112

Cc Mauro Carvalho Chehab <[email protected]>
---
 Documentation/sphinx/requirements.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/sphinx/requirements.txt +1 -1
index 489f6626de67..f8974875c0ec 100644
@@ -1,3 +1,3 @@
-docutils
+docutils<0.17
 Sphinx==2.4.4
 sphinx_rtd_theme
Signature · 1 line
2.17.1
#1 lore raw

PATCH v2 1/1 docs: sphinx-requirements: Move sphinx_rtd_theme to top

sphinx_rtd_theme 0.5.2 has "docutils<0.17" in its requirements. docutils 0.17 released this April caused regression in sphinx_rtd_theme 0.5.1 [1].

By removing docutils and moving sphinx_rtd_theme before Sphinx in requirements.txt, the requirement of "docutils<0.17" can be met naturally.

[1]: https://github.com/readthedocs/sphinx_rtd_theme/issues/1112

Cc Mauro Carvalho Chehab <[email protected]>

---
Hi,

It is better to keep requirements as minimal as possible. Let's leave the dependency to the sphinx_rtd_theme package.

Changes in v1 [2] -> v2:

o Remove docutils entry.
o Move sphinx_rtd_theme to top.
o Adjust patch title.

[2]: https://lore.kernel.org/linux-doc/[email protected]/

Thanks, Akira
--

 Documentation/sphinx/requirements.txt | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
Documentation/sphinx/requirements.txt +1 -2
index 489f6626de67..9a35f50798a6 100644
@@ -1,3 +1,2 @@
-docutils
-Sphinx==2.4.4
 sphinx_rtd_theme
+Sphinx==2.4.4
Signature · 1 line
2.17.1
maintainer Acked-by on v2 1/1
#2 lore raw

Re: [PATCH v2] docs: sphinx-requirements: Move sphinx_rtd_theme to top

Em Tue, 10 Aug 2021 18:16:32 +0900
Akira Yokosawa <[email protected]> escreveu:

Quoted 4 lines

sphinx_rtd_theme 0.5.2 has "docutils<0.17" in its requirements. docutils 0.17 released this April caused regression in sphinx_rtd_theme 0.5.1 [1].

Quoted 8 lines

By removing docutils and moving sphinx_rtd_theme before Sphinx in requirements.txt, the requirement of "docutils<0.17" can be met naturally.

[1]: https://github.com/readthedocs/sphinx_rtd_theme/issues/1112

Cc Mauro Carvalho Chehab <[email protected]>

This was needed when the minimal version was 1.x, but I guess we can just get rid of docutils explicit dependency nowadays.

Quoted 24 lines

---
Hi,

It is better to keep requirements as minimal as possible. Let's leave the dependency to the sphinx_rtd_theme package.

Changes in v1 [2] -> v2:

o Remove docutils entry.
o Move sphinx_rtd_theme to top.
o Adjust patch title.

[2]: https://lore.kernel.org/linux-doc/[email protected]/

Thanks, Akira
--

 Documentation/sphinx/requirements.txt | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
Documentation/sphinx/requirements.txt +0 -0
index 489f6626de67..9a35f50798a6 100644

Documentation/sphinx/requirements.txt line 2

Quoted 4 lines
Documentation/sphinx/requirements.txt +1 -2
@@ -1,3 +1,2 @@
-docutils
-Sphinx==2.4.4
 sphinx_rtd_theme
+Sphinx==2.4.4

Thanks,
Mauro

maintainer Applied
#3 lore raw

Re: [PATCH v2] docs: sphinx-requirements: Move sphinx_rtd_theme to top

In reply to Akira Yokosawa
Quoted 18 lines · Akira Yokosawa

sphinx_rtd_theme 0.5.2 has "docutils<0.17" in its requirements. docutils 0.17 released this April caused regression in sphinx_rtd_theme 0.5.1 [1].

By removing docutils and moving sphinx_rtd_theme before Sphinx in requirements.txt, the requirement of "docutils<0.17" can be met naturally.

[1]: https://github.com/readthedocs/sphinx_rtd_theme/issues/1112

Cc Mauro Carvalho Chehab <[email protected]>

---
Hi,

It is better to keep requirements as minimal as possible. Let's leave the dependency to the sphinx_rtd_theme package.

Quoted 7 lines

Changes in v1 [2] -> v2:

o Remove docutils entry.
o Move sphinx_rtd_theme to top.
o Adjust patch title.

[2]: https://lore.kernel.org/linux-doc/[email protected]/

Applied, thanks.

jon