[LTP] [PATCH 1/1] sphinx: Update to 7.2.6, python 3.12, ubuntu-24.04

[LTP] [PATCH 1/1] sphinx: Update to 7.2.6, python 3.12, ubuntu-24.04

[Petr Vorel]

Update sphinx to 7.2.6, python 3.12. This requires to update
.readthedocs.yml to use ubuntu-24.04 [1], because keep in sync sphinx in
readthedocs with with the one for local development and github CI.
Raising python makes sense, as development is usually done on newer
distros, we were still using old python 3.6.

This fixes the problem on local development trying to run older sphinx
5.3 on python 3.13 requires to use imghdr, which was removed from
standard library (alternatively we'd need to install it from pip via
adding standard-imghdr into requirements.txt).

[1] https://about.readthedocs.com/blog/2024/06/ubuntu-24-04/

Fixes: b900b790e9 ("doc: Add sphinx to requirements.txt")
Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
Hi,

first, I'm sorry for a regression. I tested all the previous versions
carefully even locally, but in the end the final variant I obviously
omit to test.

Tested:
https://app.readthedocs.org/projects/linux-test-project/builds/27784588/

Alternatively, we could keep old distros and just add standard-imghdr
(without version) to doc/requirements.txt. But sooner or later we will
need to upgrade thus I'm sending this version.

Kind regards,
Petr

 .readthedocs.yml     | 4 ++--
 doc/requirements.txt | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/.readthedocs.yml b/.readthedocs.yml
index 5434ef49d6..51825da77f 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -1,9 +1,9 @@
 version: 2
 
 build:
-  os: "ubuntu-22.04"
+  os: "ubuntu-24.04"
   tools:
-    python: "3.6"
+    python: "3.12"
   apt_packages:
     - autoconf
     - enchant-2
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 6302ecd9f2..1b9a984547 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,6 +1,6 @@
 # Use the same sphinx as on readthedocs.org. When updated, make sure
 # sphinx-rtd-theme is compatible with sphinx.
-sphinx==5.3.0
+sphinx==7.2.6
 sphinx-rtd-theme==2.0.0
 
 linuxdoc==20231020
-- 
2.49.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 1/1] sphinx: Update to 7.2.6, python 3.12, ubuntu-24.04

[Ricardo B. Marli��re via ltp]

Hi Petr,

On Tue Apr 8, 2025 at 8:44 AM -03, Petr Vorel wrote:
> Update sphinx to 7.2.6, python 3.12. This requires to update
> .readthedocs.yml to use ubuntu-24.04 [1], because keep in sync sphinx in
> readthedocs with with the one for local development and github CI.
> Raising python makes sense, as development is usually done on newer
> distros, we were still using old python 3.6.
>
> This fixes the problem on local development trying to run older sphinx
> 5.3 on python 3.13 requires to use imghdr, which was removed from
> standard library (alternatively we'd need to install it from pip via
> adding standard-imghdr into requirements.txt).
>
> [1] https://about.readthedocs.com/blog/2024/06/ubuntu-24-04/
>
> Fixes: b900b790e9 ("doc: Add sphinx to requirements.txt")
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
> Hi,
>
> first, I'm sorry for a regression. I tested all the previous versions
> carefully even locally, but in the end the final variant I obviously
> omit to test.
>
> Tested:
> https://app.readthedocs.org/projects/linux-test-project/builds/27784588/
>
> Alternatively, we could keep old distros and just add standard-imghdr
> (without version) to doc/requirements.txt. But sooner or later we will
> need to upgrade thus I'm sending this version.
>
> Kind regards,
> Petr
>
>  .readthedocs.yml     | 4 ++--
>  doc/requirements.txt | 2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/.readthedocs.yml b/.readthedocs.yml
> index 5434ef49d6..51825da77f 100644
> --- a/.readthedocs.yml
> +++ b/.readthedocs.yml
> @@ -1,9 +1,9 @@
>  version: 2
>  
>  build:
> -  os: "ubuntu-22.04"
> +  os: "ubuntu-24.04"
>    tools:
> -    python: "3.6"
> +    python: "3.12"

Can you please update the docs?

https://github.com/linux-test-project/ltp/blob/master/doc/developers/documentation.rst?plain=1#L36

Thanks,
-	Ricardo.


>    apt_packages:
>      - autoconf
>      - enchant-2
> diff --git a/doc/requirements.txt b/doc/requirements.txt
> index 6302ecd9f2..1b9a984547 100644
> --- a/doc/requirements.txt
> +++ b/doc/requirements.txt
> @@ -1,6 +1,6 @@
>  # Use the same sphinx as on readthedocs.org. When updated, make sure
>  # sphinx-rtd-theme is compatible with sphinx.
> -sphinx==5.3.0
> +sphinx==7.2.6
>  sphinx-rtd-theme==2.0.0
>  
>  linuxdoc==20231020


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 1/1] sphinx: Update to 7.2.6, python 3.12, ubuntu-24.04

[Ricardo B. Marli��re via ltp]

On Tue Apr 8, 2025 at 8:44 AM -03, Petr Vorel wrote:
> Update sphinx to 7.2.6, python 3.12. This requires to update
> .readthedocs.yml to use ubuntu-24.04 [1], because keep in sync sphinx in
> readthedocs with with the one for local development and github CI.
> Raising python makes sense, as development is usually done on newer
> distros, we were still using old python 3.6.
>
> This fixes the problem on local development trying to run older sphinx
> 5.3 on python 3.13 requires to use imghdr, which was removed from
> standard library (alternatively we'd need to install it from pip via
> adding standard-imghdr into requirements.txt).
>
> [1] https://about.readthedocs.com/blog/2024/06/ubuntu-24-04/
>
> Fixes: b900b790e9 ("doc: Add sphinx to requirements.txt")
> Signed-off-by: Petr Vorel <pvorel@suse.cz>

Tested-by: Ricardo B. Marlière <rbm@suse.com>
Reviewed-by: Ricardo B. Marlière <rbm@suse.com>

Tested on Tumbleweed, I was having this before:

$ make
make -C /mnt/ext/src/linux/ltp/fixes/make_doc/metadata
make[1]: Entering directory '/mnt/ext/src/linux/ltp/fixes/make_doc/metadata'
HOSTCC metadata/metaparse
HOSTCC metadata/metaparse-sh
/mnt/ext/src/linux/ltp/fixes/make_doc/metadata/parse.sh > ltp.json
make[1]: Leaving directory '/mnt/ext/src/linux/ltp/fixes/make_doc/metadata'
if [ -d .venv ]; then if [ "x" != "x" ]; then . .venv/bin/activate.fish; else . .venv/bin/activate; fi; fi;
sphinx-build -b html . html
Running Sphinx v5.3.0

Extension error:
Could not import extension sphinx.builders.epub3 (exception: No module named 'imghdr')
make: *** [Makefile:27: all] Error 2

Thank you,
-	Ricardo.


> ---
> Hi,
>
> first, I'm sorry for a regression. I tested all the previous versions
> carefully even locally, but in the end the final variant I obviously
> omit to test.
>
> Tested:
> https://app.readthedocs.org/projects/linux-test-project/builds/27784588/
>
> Alternatively, we could keep old distros and just add standard-imghdr
> (without version) to doc/requirements.txt. But sooner or later we will
> need to upgrade thus I'm sending this version.
>
> Kind regards,
> Petr
>
>  .readthedocs.yml     | 4 ++--
>  doc/requirements.txt | 2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/.readthedocs.yml b/.readthedocs.yml
> index 5434ef49d6..51825da77f 100644
> --- a/.readthedocs.yml
> +++ b/.readthedocs.yml
> @@ -1,9 +1,9 @@
>  version: 2
>
>  build:
> -  os: "ubuntu-22.04"
> +  os: "ubuntu-24.04"
>    tools:
> -    python: "3.6"
> +    python: "3.12"
>    apt_packages:
>      - autoconf
>      - enchant-2
> diff --git a/doc/requirements.txt b/doc/requirements.txt
> index 6302ecd9f2..1b9a984547 100644
> --- a/doc/requirements.txt
> +++ b/doc/requirements.txt
> @@ -1,6 +1,6 @@
>  # Use the same sphinx as on readthedocs.org. When updated, make sure
>  # sphinx-rtd-theme is compatible with sphinx.
> -sphinx==5.3.0
> +sphinx==7.2.6
>  sphinx-rtd-theme==2.0.0
>
>  linuxdoc==20231020


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 1/1] sphinx: Update to 7.2.6, python 3.12, ubuntu-24.04

[Petr Vorel]

Hi Ricardo,

...
> > -    python: "3.6"
> > +    python: "3.12"

> Can you please update the docs?

> https://github.com/linux-test-project/ltp/blob/master/doc/developers/documentation.rst?plain=1#L36

Good point, thanks! I'm going to merge with the change below.
I'll merge in few hours, to give you and Andrea time to have a look.

Kind regards,
Petr

> Thanks,
> -	Ricardo.

+++ doc/developers/documentation.rst
@@ -33,9 +33,9 @@ Once the procedure has been completed, documentation will be visible at
 
 .. warning::
 
-    The current :master:`.readthedocs.yml` workflow is using ``Python 3.6`` because
-    older Python versions were causing issues. No other version has been tested,
-    but it should work anyway.
+    Documentation requires ``Python >= 3.6``.
+    The current :master:`.readthedocs.yml` workflow is using ``Python 3.12``,
+    it is tested in GitHub Actions :master:`.github/workflows/ci-sphinx-doc.yml`.
 
 Validating spelling
 ~~~~~~~~~~~~~~~~~~~

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 1/1] sphinx: Update to 7.2.6, python 3.12, ubuntu-24.04

[pvorel]

Hi Andrea,

On 2025-04-15 12:07, Andrea Cervesato wrote:
> Hi Petr,
> 
> feel free to merge.

Thanks for your ack.

FYI You did not Cc LTP ML, therefore I noticed this after push to 
master. But as it was just few minutes after the push, I dared to force 
push the master with amended commit message.

Kind regards,
Petr

> 
> Acked-by: Andrea Cervesato <andrea.cervesato@suse.com>
> 
> On 4/8/25 13:44, Petr Vorel wrote:
>> Update sphinx to 7.2.6, python 3.12. This requires to update
>> .readthedocs.yml to use ubuntu-24.04 [1], because keep in sync sphinx 
>> in
>> readthedocs with with the one for local development and github CI.
>> Raising python makes sense, as development is usually done on newer
>> distros, we were still using old python 3.6.
>> 
>> This fixes the problem on local development trying to run older sphinx
>> 5.3 on python 3.13 requires to use imghdr, which was removed from
>> standard library (alternatively we'd need to install it from pip via
>> adding standard-imghdr into requirements.txt).
>> 
>> [1] https://about.readthedocs.com/blog/2024/06/ubuntu-24-04/
>> 
>> Fixes: b900b790e9 ("doc: Add sphinx to requirements.txt")
>> Signed-off-by: Petr Vorel <pvorel@suse.cz>
>> ---
>> Hi,
>> 
>> first, I'm sorry for a regression. I tested all the previous versions
>> carefully even locally, but in the end the final variant I obviously
>> omit to test.
>> 
>> Tested:
>> https://app.readthedocs.org/projects/linux-test-project/builds/27784588/
>> 
>> Alternatively, we could keep old distros and just add standard-imghdr
>> (without version) to doc/requirements.txt. But sooner or later we will
>> need to upgrade thus I'm sending this version.
>> 
>> Kind regards,
>> Petr
>> 
>>   .readthedocs.yml     | 4 ++--
>>   doc/requirements.txt | 2 +-
>>   2 files changed, 3 insertions(+), 3 deletions(-)
>> 
>> diff --git a/.readthedocs.yml b/.readthedocs.yml
>> index 5434ef49d6..51825da77f 100644
>> --- a/.readthedocs.yml
>> +++ b/.readthedocs.yml
>> @@ -1,9 +1,9 @@
>>   version: 2
>>     build:
>> -  os: "ubuntu-22.04"
>> +  os: "ubuntu-24.04"
>>     tools:
>> -    python: "3.6"
>> +    python: "3.12"
>>     apt_packages:
>>       - autoconf
>>       - enchant-2
>> diff --git a/doc/requirements.txt b/doc/requirements.txt
>> index 6302ecd9f2..1b9a984547 100644
>> --- a/doc/requirements.txt
>> +++ b/doc/requirements.txt
>> @@ -1,6 +1,6 @@
>>   # Use the same sphinx as on readthedocs.org. When updated, make sure
>>   # sphinx-rtd-theme is compatible with sphinx.
>> -sphinx==5.3.0
>> +sphinx==7.2.6
>>   sphinx-rtd-theme==2.0.0
>>     linuxdoc==20231020

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp