Bug 2221977 - poezio fails to build with Sphinx 7.x
Summary: poezio fails to build with Sphinx 7.x
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: poezio
Version: 39
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Matthieu Saulnier
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 2188968
TreeView+ depends on / blocked
 
Reported: 2023-07-11 12:10 UTC by Karolina Surma
Modified: 2023-11-19 18:27 UTC (History)
1 user (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2023-11-19 18:27:54 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Karolina Surma 2023-07-11 12:10:00 UTC
poezio fails to build with Sphinx 7.x in Fedora 39 (currently Rawhide).

The issue detected:
```
+ sphinx-build -b html docs
<snip>
Theme error:
An error happened in rendering the page ....
Reason: UndefinedError("'style' is undefined")
```

Sphinx 7 has removed the `style` key for HTML templates (see: https://github.com/sphinx-doc/sphinx/pull/11381).
This can indicate an issue with the Sphinx theme the package uses rather than the package itself.

It should be possible to fix this by replacing the usage of `style` with `styles[-1] in `theme/layout.html`:
-    <link rel="stylesheet" href="{ pathto('_static/' + style, 1) }" type="text/css" />
+    <link rel="stylesheet" href="{ pathto('_static/' + styles[-1], 1) }" type="text/css" />
Please note it may not be the best solution in your specific case.

For the logs from testing build attempts, see:
https://copr.fedorainfracloud.org/coprs/ksurma/doc-stack/package/poezio/

You can test you package in mock running:

$ mock -r fedora-rawhide-x86_64 --addrepo=https://download.copr.fedorainfracloud.org/results/ksurma/doc-stack/fedora-rawhide-x86_64/ --no-clean your.src.rpm
$ mock -r fedora-rawhide-x86_64 --addrepo=https://download.copr.fedorainfracloud.org/results/ksurma/doc-stack/fedora-rawhide-x86_64/ shell

We'd like to include Sphinx 7 in Fedora 39.
Let us know here if you have any questions. Thank you!

Comment 1 Fedora Release Engineering 2023-08-16 07:19:13 UTC
This bug appears to have been reported against 'rawhide' during the Fedora Linux 39 development cycle.
Changing version to 39.

Comment 2 Matthieu Saulnier 2023-11-19 18:27:54 UTC
The issue was located in the sphinx readthedocs theme used in the package.


Note You need to log in before you can comment on or make changes to this bug.