* [PATCH] docs: freeze some package versions for sphinx virtualenv setup
@ 2024-02-26 9:38 Lukas Bulwahn
2024-02-27 6:56 ` Akira Yokosawa
0 siblings, 1 reply; 5+ messages in thread
From: Lukas Bulwahn @ 2024-02-26 9:38 UTC (permalink / raw)
To: Jonathan Corbet, Akira Yokosawa, Jani Nikula, linux-doc,
Vegard Nossum, Mauro Carvalho Chehab
Cc: kernel-janitors, linux-kernel, Lukas Bulwahn
If you currently follow the instructions for sphinx install:
/usr/bin/python3 -m venv sphinx_2.4.4
. sphinx_2.4.4/bin/activate
pip install -r ./Documentation/sphinx/requirements.txt
you encounter an error during make htmldocs:
Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs
at least Sphinx v5.0; it therefore cannot be built with this version.
Akira-san Yokosawa reported this already in January 2023 and Jani Nikula
was fast in providing a fix (see Link). This however remained as a thread
on the linux-doc mailing and was never turned into a patch for Jonathan to
pick up.
Fix some versions for the Sphinx 2.4.4 to continue to work.
Link: https://lore.kernel.org/linux-doc/cb72b3d6-de7a-4c8a-a99c-72d58a23f89c@gmail.com/
Reported-by: Akira Yokosawa <akiyks@gmail.com>
Closes: https://lore.kernel.org/linux-doc/cb72b3d6-de7a-4c8a-a99c-72d58a23f89c@gmail.com/
Suggested-by: Jani Nikula <jani.nikula@linux.intel.com>
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
Documentation/sphinx/requirements.txt | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
index 5d47ed443949..0aa4fdb84632 100644
--- a/Documentation/sphinx/requirements.txt
+++ b/Documentation/sphinx/requirements.txt
@@ -2,5 +2,10 @@
jinja2<3.1
# alabaster>=0.7.14 is not compatible with Sphinx<=3.3
alabaster<0.7.14
+sphinxcontrib-applehelp==1.0.4
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
Sphinx==2.4.4
pyyaml
--
2.43.2
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: freeze some package versions for sphinx virtualenv setup
2024-02-26 9:38 [PATCH] docs: freeze some package versions for sphinx virtualenv setup Lukas Bulwahn
@ 2024-02-27 6:56 ` Akira Yokosawa
2024-02-27 8:24 ` Lukas Bulwahn
0 siblings, 1 reply; 5+ messages in thread
From: Akira Yokosawa @ 2024-02-27 6:56 UTC (permalink / raw)
To: lukas.bulwahn; +Cc: akiyks, corbet, vegard.nossum, linux-doc
[dropping most CCs]
Hello Lukas,
This is a friendly notice for filling in some contexts.
On Mon, 26 Feb 2024 10:38:54 +0100, Lukas Bulwahn wrote:
[...]
> Akira-san Yokosawa reported this already in January 2023 and Jani Nikula
> was fast in providing a fix (see Link). This however remained as a thread
> on the linux-doc mailing and was never turned into a patch for Jonathan to
> pick up.
Have you read Jon's message in the thread archived at:
https://lore.kernel.org/linux-doc/874jf4m384.fsf@meer.lwn.net/
I think you can see why there had been no submission of a proper patch
in your patch's direction nor others.
If you still want your patch applied soon, you need to convince Jon.
A patch that helps us to go in the direction of 1) in Jon's message is
most welcome!
Be aware that if you simply remove ==2.4.4 from requirements.txt,
sphinx-pre-install will prevent you from running "make htmldocs".
You'll see this error:
Can't get default sphinx version from ./Documentation/sphinx/requirements.txt at ./scripts/sphinx-pre-install line 305.
Happy hacking!
Thanks, Akira
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: freeze some package versions for sphinx virtualenv setup
2024-02-27 6:56 ` Akira Yokosawa
@ 2024-02-27 8:24 ` Lukas Bulwahn
2024-02-27 8:40 ` Vegard Nossum
0 siblings, 1 reply; 5+ messages in thread
From: Lukas Bulwahn @ 2024-02-27 8:24 UTC (permalink / raw)
To: Akira Yokosawa; +Cc: corbet, vegard.nossum, linux-doc
On Tue, Feb 27, 2024 at 7:57 AM Akira Yokosawa <akiyks@gmail.com> wrote:
>
> [dropping most CCs]
>
> Hello Lukas,
>
> This is a friendly notice for filling in some contexts.
>
> On Mon, 26 Feb 2024 10:38:54 +0100, Lukas Bulwahn wrote:
> [...]
> > Akira-san Yokosawa reported this already in January 2023 and Jani Nikula
> > was fast in providing a fix (see Link). This however remained as a thread
> > on the linux-doc mailing and was never turned into a patch for Jonathan to
> > pick up.
>
> Have you read Jon's message in the thread archived at:
>
> https://lore.kernel.org/linux-doc/874jf4m384.fsf@meer.lwn.net/
>
> I think you can see why there had been no submission of a proper patch
> in your patch's direction nor others.
>
> If you still want your patch applied soon, you need to convince Jon.
>
> A patch that helps us to go in the direction of 1) in Jon's message is
> most welcome!
>
> Be aware that if you simply remove ==2.4.4 from requirements.txt,
> sphinx-pre-install will prevent you from running "make htmldocs".
>
> You'll see this error:
>
> Can't get default sphinx version from ./Documentation/sphinx/requirements.txt at ./scripts/sphinx-pre-install line 305.
>
Yes, I have seen Jonathan's message. I also read that updating to
recent versions---despite the slight performance issues---is the way
forward. I will try out if I can make a proper patch to get that setup
working.
However, I also read:
Jonathan is "happy to not break 2.4.4 for now, though I suspect that
day may come". Hence, as the current sphinx 2.4.4 setup is broken and
still the one and only way that is documented on how to set up the
kernel documentation build, I thought we will need to at least get
that back into the working state until the documentation for how to
use the new versions is in place.
Hence, I proposed this patch here. It works (for me). But I do not
care if it is picked or not---because I am just continuing the
whack-a-mole game. As of now, I do not know how much work the better
solution for "updating to recent versions" needs. I will spend half a
day and hopefully I can then present a good working patch. But let us
see.
Lukas
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: freeze some package versions for sphinx virtualenv setup
2024-02-27 8:24 ` Lukas Bulwahn
@ 2024-02-27 8:40 ` Vegard Nossum
2024-02-27 13:17 ` Lukas Bulwahn
0 siblings, 1 reply; 5+ messages in thread
From: Vegard Nossum @ 2024-02-27 8:40 UTC (permalink / raw)
To: Lukas Bulwahn, Akira Yokosawa; +Cc: corbet, linux-doc
On 27/02/2024 09:24, Lukas Bulwahn wrote:
> On Tue, Feb 27, 2024 at 7:57 AM Akira Yokosawa <akiyks@gmail.com> wrote:
>> On Mon, 26 Feb 2024 10:38:54 +0100, Lukas Bulwahn wrote:
>>> Akira-san Yokosawa reported this already in January 2023 and Jani Nikula
>>> was fast in providing a fix (see Link). This however remained as a thread
>>> on the linux-doc mailing and was never turned into a patch for Jonathan to
>>> pick up.
>>
>> Have you read Jon's message in the thread archived at:
>>
>> https://lore.kernel.org/linux-doc/874jf4m384.fsf@meer.lwn.net/
>>
>> I think you can see why there had been no submission of a proper patch
>> in your patch's direction nor others.
>>
>> If you still want your patch applied soon, you need to convince Jon.
[...]
> Hence, I proposed this patch here. It works (for me). But I do not
> care if it is picked or not---because I am just continuing the
> whack-a-mole game. As of now, I do not know how much work the better
> solution for "updating to recent versions" needs. I will spend half a
> day and hopefully I can then present a good working patch. But let us
> see.
I now locally have a file requirements-2.4.4.txt that was the result of
running 'pip freeze' in a working Sphinx-2.4.4 virtualenv:
alabaster==0.7.13
Babel==2.14.0
certifi==2024.2.2
charset-normalizer==3.3.2
docutils==0.20.1
idna==3.6
imagesize==1.4.1
Jinja2==3.0.3
MarkupSafe==2.1.5
packaging==23.2
Pygments==2.17.2
PyYAML==6.0.1
requests==2.31.0
snowballstemmer==2.2.0
Sphinx==2.4.4
sphinxcontrib-applehelp==1.0.4
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
urllib3==2.2.0
My preferred way forward would be to put this in
Documentation/sphinx/requirements-2.4.4.txt and then update
Documentation/sphinx/requirements.txt to be completely unconstrained as
much as possible (just specify the bare minimum set of packages with
only lower bounds on the versions).
If you agree with the approach, feel free to submit that as a patch (if
not, I can submit one in the next few days), I just didn't want to snipe
your contribution.
Vegard
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: freeze some package versions for sphinx virtualenv setup
2024-02-27 8:40 ` Vegard Nossum
@ 2024-02-27 13:17 ` Lukas Bulwahn
0 siblings, 0 replies; 5+ messages in thread
From: Lukas Bulwahn @ 2024-02-27 13:17 UTC (permalink / raw)
To: Vegard Nossum; +Cc: Akira Yokosawa, corbet, linux-doc
On Tue, Feb 27, 2024 at 9:41 AM Vegard Nossum <vegard.nossum@oracle.com> wrote:
>
>
> On 27/02/2024 09:24, Lukas Bulwahn wrote:
> > On Tue, Feb 27, 2024 at 7:57 AM Akira Yokosawa <akiyks@gmail.com> wrote:
> >> On Mon, 26 Feb 2024 10:38:54 +0100, Lukas Bulwahn wrote:
> >>> Akira-san Yokosawa reported this already in January 2023 and Jani Nikula
> >>> was fast in providing a fix (see Link). This however remained as a thread
> >>> on the linux-doc mailing and was never turned into a patch for Jonathan to
> >>> pick up.
> >>
> >> Have you read Jon's message in the thread archived at:
> >>
> >> https://lore.kernel.org/linux-doc/874jf4m384.fsf@meer.lwn.net/
> >>
> >> I think you can see why there had been no submission of a proper patch
> >> in your patch's direction nor others.
> >>
> >> If you still want your patch applied soon, you need to convince Jon.
>
> [...]
>
> > Hence, I proposed this patch here. It works (for me). But I do not
> > care if it is picked or not---because I am just continuing the
> > whack-a-mole game. As of now, I do not know how much work the better
> > solution for "updating to recent versions" needs. I will spend half a
> > day and hopefully I can then present a good working patch. But let us
> > see.
>
> I now locally have a file requirements-2.4.4.txt that was the result of
> running 'pip freeze' in a working Sphinx-2.4.4 virtualenv:
>
> alabaster==0.7.13
> Babel==2.14.0
> certifi==2024.2.2
> charset-normalizer==3.3.2
> docutils==0.20.1
> idna==3.6
> imagesize==1.4.1
> Jinja2==3.0.3
> MarkupSafe==2.1.5
> packaging==23.2
> Pygments==2.17.2
> PyYAML==6.0.1
> requests==2.31.0
> snowballstemmer==2.2.0
> Sphinx==2.4.4
> sphinxcontrib-applehelp==1.0.4
> sphinxcontrib-devhelp==1.0.2
> sphinxcontrib-htmlhelp==2.0.1
> sphinxcontrib-jsmath==1.0.1
> sphinxcontrib-qthelp==1.0.3
> sphinxcontrib-serializinghtml==1.1.5
> urllib3==2.2.0
>
> My preferred way forward would be to put this in
> Documentation/sphinx/requirements-2.4.4.txt and then update
> Documentation/sphinx/requirements.txt to be completely unconstrained as
> much as possible (just specify the bare minimum set of packages with
> only lower bounds on the versions).
>
> If you agree with the approach, feel free to submit that as a patch (if
> not, I can submit one in the next few days), I just didn't want to snipe
> your contribution.
>
Vegard,
I tried to look into the "completely unconstrained as much as
possible" proposal and looked into what I can reduce in the
sphinx_preinstall. I have just shared the changes here:
https://lore.kernel.org/linux-doc/20240227131410.35269-1-lukas.bulwahn@gmail.com/
Feel free to pick up this patch; I will probably not touch this for a
week now and just see if it works for others or if others will pick it
up.
Best regards,
Lukas
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2024-02-27 13:17 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-02-26 9:38 [PATCH] docs: freeze some package versions for sphinx virtualenv setup Lukas Bulwahn
2024-02-27 6:56 ` Akira Yokosawa
2024-02-27 8:24 ` Lukas Bulwahn
2024-02-27 8:40 ` Vegard Nossum
2024-02-27 13:17 ` Lukas Bulwahn
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).