docs: Set upper limit of docutils (<0.17)
Subsystems (2)
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
--- Documentation/sphinx/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/sphinx/requirements.txt +1 -1
@@ -1,3 +1,3 @@ -docutils +docutils<0.17 Sphinx==2.4.4 sphinx_rtd_theme
Signature · 1 line
2.17.1
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
---
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
@@ -1,3 +1,2 @@ -docutils -Sphinx==2.4.4 sphinx_rtd_theme +Sphinx==2.4.4
Signature · 1 line
2.17.1
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_theme0.5.2 has "docutils<0.17" in its requirements. docutils 0.17 released this April caused regression insphinx_rtd_theme0.5.1 [1].
Quoted 8 lines
By removing docutils and moving
sphinx_rtd_themebefore Sphinx in requirements.txt, the requirement of "docutils<0.17" can be met naturally.[1]: https://github.com/readthedocs/sphinx_rtd_theme/issues/1112
Signed-off-by Akira Yokosawa <[email protected]>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_themepackage.Changes in v1 [2] -> v2:
o Remove docutils entry.
o Movesphinx_rtd_themeto 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
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
Re: [PATCH v2] docs: sphinx-requirements: Move sphinx_rtd_theme to top
In reply to Akira YokosawaQuoted 18 lines · Akira Yokosawa
sphinx_rtd_theme0.5.2 has "docutils<0.17" in its requirements. docutils 0.17 released this April caused regression insphinx_rtd_theme0.5.1 [1].By removing docutils and moving
sphinx_rtd_themebefore Sphinx in requirements.txt, the requirement of "docutils<0.17" can be met naturally.[1]: https://github.com/readthedocs/sphinx_rtd_theme/issues/1112
Signed-off-by Akira Yokosawa <[email protected]>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_themepackage.
Quoted 7 lines
Changes in v1 [2] -> v2:
o Remove docutils entry.
o Movesphinx_rtd_themeto top.
o Adjust patch title.
Applied, thanks.
jon