-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation fails to build with sphinx 7.4.7 #9938
Comments
The library's documentation is explicitly built with Sphinx 4.4.0 as per the pyproject.toml file. There's no such pressure to update the Sphinx used since they undergo breaking changes semi-frequently. We have one PR (#9556) for it but it involved way too many hacks and compatibility workarounds to really put time into merging and thus is stale. In order to fix your issue you should use the Sphinx version specified in the pyproject.toml rather than using the bumped version though, especially since the breaking changes include significant styling changes from base Sphinx. |
We only have one sphinx version in the Debian or Ubuntu archive (see https://tracker.debian.org/pkg/sphinx and https://launchpad.net/ubuntu/+source/sphinx). The old Sphinx 4.4.0 version is not available any more. We either need to carry a patch in the packaging to make it work with the newer version or drop the documentation (or the complete package). |
Summary
Documentation fails to build with sphinx 7.4.7
Reproduction Steps
python-discord fails to build on Debian and Ubuntu, because the documentation fails to build with sphinx 7.4.7.
Minimal Reproducible Code
Expected Results
produce documentation
Actual Results
Intents
not relevant
System Information
Debian unstable and Ubuntu 24.10 (oracular)
Checklist
Additional Context
Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/python-discord/+bug/2079808
The text was updated successfully, but these errors were encountered: