sphinx icon indicating copy to clipboard operation
sphinx copied to clipboard

Sphinx 5.2.0.post0 error with `sphinx_rtd_theme`: ValueError 'too many values to unpack'

Open StratFinancePy opened this issue 3 years ago • 10 comments

Describe the bug

Theme error: [123] An error happened in rendering the page _autosummary/. [124] Reason: ValueError('too many values to unpack (expected 3)')

How to Reproduce

(To be added soon)

Expected behavior

Proper page rendering as in Sphinx 5.1.1.

Your project

(Not applicable)

Screenshots

No response

OS

linux

Python version

3.10

Sphinx version

5.2.0

Sphinx extensions

autosummary

Extra tools

No response

Additional context

No response

StratFinancePy avatar Sep 25 '22 08:09 StratFinancePy

Sorry for the limited information, will try to provide a way to reproduce the issue soon but mostly wanted to flag a regression between 5.1.1 and 5.2.0

StratFinancePy avatar Sep 25 '22 08:09 StratFinancePy

ReadTheDocs constantly reproduces the issue when you use the site's build feature.

natt96z avatar Sep 25 '22 09:09 natt96z

I am slightly too late but here is an analysis: https://github.com/sphinx-doc/sphinx/issues/10853#issuecomment-1257153452

But it is actually a sphinx_rtd_theme issue: https://github.com/readthedocs/sphinx_rtd_theme/issues/1343 Either sphinx_rtd_theme needs to release with a fix, or sphinx needs to release without a .post0 release. The first is technically correct, but the second might happen first.

Suggested issue title: "5.2.0.post0 error with sphinx_rtd_theme, ValueError unpacking version"

rkdarst avatar Sep 25 '22 09:09 rkdarst

Work around: prohibit the .post0 release in your requirements:

sphinx!=5.2.0.post0    # remove after next release

Of course this is a massive amount of work for everyone who uses sphinx_rtd_theme, so I hope one of the two will release soon.

rkdarst avatar Sep 25 '22 09:09 rkdarst

Same problem with pypdfium2's docs: https://readthedocs.org/projects/pypdfium2/builds/18162606/

mara004 avatar Sep 25 '22 10:09 mara004

thank you very much @rkdarst, I'm indeed using read the doc theme so might be the issue that you linked: https://github.com/sphinx-doc/sphinx/issues/10853#issuecomment-1257153452

StratFinancePy avatar Sep 25 '22 16:09 StratFinancePy

happy to close the issue too as it might be specific to read the doc theme

StratFinancePy avatar Sep 25 '22 16:09 StratFinancePy

I think it's better to leave it open (maybe change the title?), since countless people are going to be looking here for a solution until it gets fixed.

rkdarst avatar Sep 25 '22 16:09 rkdarst

Yes, seeing this report and the cross-reference to sphinx_rtd_theme directly was quite helpful.

mara004 avatar Sep 25 '22 17:09 mara004

I will release 5.2.1 shortly.

RTD's theme should really use the version tuple attribute we provide, rather than somewhat clumsily introspecting the string version.

A

AA-Turner avatar Sep 25 '22 17:09 AA-Turner

Sphinx 5.2.1 has been released.

A

AA-Turner avatar Sep 25 '22 20:09 AA-Turner