[PATCH] docs: Set upper limit of docutils (<0.17)

[PATCH] docs: Set upper limit of docutils (<0.17)

[Akira Yokosawa]

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

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
---
 Documentation/sphinx/requirements.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
index 489f6626de67..f8974875c0ec 100644
--- a/Documentation/sphinx/requirements.txt
+++ b/Documentation/sphinx/requirements.txt
@@ -1,3 +1,3 @@
-docutils
+docutils<0.17
 Sphinx==2.4.4
 sphinx_rtd_theme
-- 
2.17.1

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

[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

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
---
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/974babfe-540f-40e4-38b3-ab294ba70ccc@gmail.com/

        Thanks, Akira
--
 Documentation/sphinx/requirements.txt | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
index 489f6626de67..9a35f50798a6 100644
--- a/Documentation/sphinx/requirements.txt
+++ b/Documentation/sphinx/requirements.txt
@@ -1,3 +1,2 @@
-docutils
-Sphinx==2.4.4
 sphinx_rtd_theme
+Sphinx==2.4.4
-- 
2.17.1

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

[Mauro Carvalho Chehab]

Em Tue, 10 Aug 2021 18:16:32 +0900
Akira Yokosawa <akiyks@gmail.com> escreveu:

> 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
> 
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>

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

Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>

> ---
> 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/974babfe-540f-40e4-38b3-ab294ba70ccc@gmail.com/
> 
>         Thanks, Akira
> --
>  Documentation/sphinx/requirements.txt | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
> index 489f6626de67..9a35f50798a6 100644
> --- a/Documentation/sphinx/requirements.txt
> +++ b/Documentation/sphinx/requirements.txt
> @@ -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

[Jonathan Corbet]

Akira Yokosawa <akiyks@gmail.com> writes:

> 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
>
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
> 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/974babfe-540f-40e4-38b3-ab294ba70ccc@gmail.com/

Applied, thanks.

jon