Bug 2221981

Summary: suil fails to build with Sphinx 7.x
Product: [Fedora] Fedora Reporter: Karolina Surma <ksurma>
Component: suilAssignee: Nils Philippsen <nphilipp>
Status: CLOSED ERRATA QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 39CC: brendan.jones.it, guido.aulisi, nphilipp
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: suil-0.10.18-1.el9 suil-0.10.18-1.fc37 suil-0.10.18-1.fc38 suil-0.10.18-1.fc39 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-09-08 02:02:35 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 2188968    

Description Karolina Surma 2023-07-11 12:10:40 UTC
suil 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/suil/

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:18 UTC
This bug appears to have been reported against 'rawhide' during the Fedora Linux 39 development cycle.
Changing version to 39.

Comment 2 Nils Philippsen 2023-08-30 11:54:14 UTC
I'll update to 0.10.18 which doesn’t seem to have this issue anymore.

Comment 3 Fedora Update System 2023-08-30 14:01:21 UTC
FEDORA-2023-555e1a5a53 has been submitted as an update to Fedora 39. https://bodhi.fedoraproject.org/updates/FEDORA-2023-555e1a5a53

Comment 4 Fedora Update System 2023-08-30 14:01:22 UTC
FEDORA-2023-bd9504f07b has been submitted as an update to Fedora 38. https://bodhi.fedoraproject.org/updates/FEDORA-2023-bd9504f07b

Comment 5 Fedora Update System 2023-08-31 01:48:12 UTC
FEDORA-2023-555e1a5a53 has been pushed to the Fedora 39 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf upgrade --enablerepo=updates-testing --refresh --advisory=FEDORA-2023-555e1a5a53`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2023-555e1a5a53

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 6 Fedora Update System 2023-08-31 01:57:24 UTC
FEDORA-2023-bd9504f07b has been pushed to the Fedora 38 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf upgrade --enablerepo=updates-testing --refresh --advisory=FEDORA-2023-bd9504f07b`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2023-bd9504f07b

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 7 Fedora Update System 2023-08-31 02:23:00 UTC
FEDORA-2023-d6908d05ec has been pushed to the Fedora 37 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf upgrade --enablerepo=updates-testing --refresh --advisory=FEDORA-2023-d6908d05ec`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2023-d6908d05ec

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 8 Fedora Update System 2023-08-31 02:33:47 UTC
FEDORA-EPEL-2023-b442db43c5 has been pushed to the Fedora EPEL 9 testing repository.

You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-EPEL-2023-b442db43c5

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 9 Fedora Update System 2023-09-08 02:02:35 UTC
FEDORA-EPEL-2023-b442db43c5 has been pushed to the Fedora EPEL 9 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 10 Fedora Update System 2023-09-08 02:39:26 UTC
FEDORA-2023-d6908d05ec has been pushed to the Fedora 37 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 11 Fedora Update System 2023-09-08 02:46:23 UTC
FEDORA-2023-bd9504f07b has been pushed to the Fedora 38 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 12 Fedora Update System 2023-09-15 18:43:57 UTC
FEDORA-2023-555e1a5a53 has been pushed to the Fedora 39 stable repository.
If problem still persists, please make note of it in this bug report.