BUG: Compatibility issue with docutils resolved#17
Merged
Conversation
An error is caused by sphinx-tabs being incompatible with Docutils
0.22 (Docutils 0.22 removed the "backrefs" attribute, and sphinx-tabs
crashes when it tries attrs.pop("backrefs")).
Error reported on github workflow, now fixed.
writing output... [ 87%] developer/workflows
writing output... [ 88%] examples
writing output... [ 90%] faq
writing output... [ 92%] index
Versions
========
* Platform: linux; (Linux-6.11.0-1018-azure-x86_64-with-glibc2.39)
* Python version: 3.11.14 (CPython)
* Sphinx version: 9.0.4
* Docutils version: 0.22.4
* Jinja2 version: 3.1.6
* Pygments version: 2.19.2
Last Messages
=============
faq
writing output... [ 92%]
index
writing output... [ 93%]
installation
Loaded Extensions
=================
* sphinx.ext.mathjax (9.0.4)
* alabaster (1.0.0)
* sphinxcontrib.applehelp (2.0.0)
* sphinxcontrib.devhelp (2.0.0)
* sphinxcontrib.htmlhelp (2.1.0)
* sphinxcontrib.serializinghtml (2.0.0)
* sphinxcontrib.qthelp (2.0.0)
* sphinx.ext.autodoc (9.0.4)
* sphinx.ext.napoleon (9.0.4)
* sphinx.ext.viewcode (9.0.4)
* sphinx.ext.intersphinx (9.0.4)
* sphinx.ext.todo (9.0.4)
* sphinx.ext.coverage (9.0.4)
* sphinx_autodoc_typehints (unknown version)
* sphinx_copybutton (0.5.2)
* sphinx_tabs.tabs (unknown version)
* myst_parser (5.0.0)
* sphinxcontrib.jquery (4.1)
* sphinx_rtd_theme (unknown version)
Traceback
=========
File "/opt/hostedtoolcache/Python/3.11.14/x64/lib/python3.11/site-packages/sphinx_tabs/tabs.py", line 69, in visit
attrs.pop("backrefs")
KeyError: 'backrefs'
The full traceback has been saved in:
/tmp/sphinx-err-r0ph0hb1.log
To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.
make: *** [Makefile:19: html] Error 2
writing output... [ 93%] installation
Error: Process completed with exit code 2.
There was a problem hiding this comment.
Pull request overview
This PR resolves a build failure in the documentation pipeline caused by an incompatibility between sphinx-tabs and docutils 0.22. The issue occurs because docutils 0.22 removed the "backrefs" attribute that sphinx-tabs attempts to access, resulting in a KeyError during documentation builds.
Changes:
- Added a version constraint
docutils<0.22to the docs optional dependencies in pyproject.toml to prevent installation of incompatible docutils versions
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
An error is caused by sphinx-tabs being incompatible with Docutils 0.22 (Docutils 0.22 removed the "backrefs" attribute, and sphinx-tabs crashes when it tries attrs.pop("backrefs")).
Error reported on github workflow, now fixed.
writing output... [ 87%] developer/workflows
writing output... [ 88%] examples
writing output... [ 90%] faq
writing output... [ 92%] index
Versions
Last Messages
Loaded Extensions
Traceback
The full traceback has been saved in:
/tmp/sphinx-err-r0ph0hb1.log
To report this error to the developers, please open an issue at https://github.com/sphinx-doc/sphinx/issues/. Thanks! Please also report this if it was a user error, so that a better error message can be provided next time. make: *** [Makefile:19: html] Error 2
writing output... [ 93%] installation
Error: Process completed with exit code 2.