Skip to content
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

Incompatibility with sphinx 4.3.0 #427

Closed
kousu opened this issue Nov 11, 2021 · 2 comments · Fixed by #429
Closed

Incompatibility with sphinx 4.3.0 #427

kousu opened this issue Nov 11, 2021 · 2 comments · Fixed by #429
Labels
bug Something isn't working

Comments

@kousu
Copy link
Contributor

kousu commented Nov 11, 2021

Describe the problem

If I install the latest sphinx, 4.3.0, and try to build, I hit

  File "<....>/site-packages/pydata_sphinx_theme/bootstrap_html_translator.py", line 34, in visit_table
    self._table_row_index = 0
AttributeError: can't set attribute

If I use sphinx 4.2.0, it builds fine.

Here's the full error log: sphinx-err-4aruhc6m.log.

Link to your repository or website

https://github.com/neuropoly/neuropoly-docs/tree/pydata_theme_broken

Steps to reproduce

git clone -b pydata_theme_broken --depth 1 https://github.com/neuropoly/neuropoly-docs/
cd neuropoly-docs
python3 -m venv .venv
. .venv/bin/activate
pip install .[sphinx]
make html

The version of Python you're using

3.6, 3.9

Your operating system

Ubuntu 18.04, Ubuntu 20.04

Versions of your packages

$ pip freeze
alabaster==0.7.12
attrs==21.2.0
Babel==2.9.1
beautifulsoup4==4.10.0
certifi==2021.10.8
charset-normalizer==2.0.7
click==7.1.2
docutils==0.17.1
idna==3.3
imagesize==1.3.0
importlib-resources==3.3.1
Jinja2==3.0.3
markdown-it-py==1.1.0
MarkupSafe==2.0.1
mdit-py-plugins==0.2.8
myst-parser==0.15.2
neuropoly-docs==0.0.0
packaging==21.2
pkg-resources==0.0.0
pydata-sphinx-theme==0.6.3
Pygments==2.10.0
pyparsing==2.4.7
pytz==2021.3
PyYAML==6.0
requests==2.26.0
snowballstemmer==2.1.0
soupsieve==2.3
Sphinx==4.3.0
sphinx-book-theme==0.1.6
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
typing-extensions==3.10.0.2
urllib3==1.26.7
zipp==3.6.0

Additional context

You can see https://github.com/neuropoly/neuropoly-docs/tree/pydata_theme_broken trying to build at https://github.com/neuropoly/neuropoly-docs/runs/4174367220?check_suite_focus=true (full log: broken.log). It hits the same error I get locally.

https://github.com/neuropoly/neuropoly-docs/tree/pydata_theme_works succeeds at https://github.com/neuropoly/neuropoly-docs/runs/4174371532?check_suite_focus=true (full log: works.log)

The only difference is that sphinx is downgraded in the latter:

$ git diff pydata_theme_broken..pydata_theme_works
diff --git a/setup.py b/setup.py
index c7dd802..535ee6b 100644
--- a/setup.py
+++ b/setup.py
@@ -17,7 +17,7 @@ setup(
     author="NeuroPoly",
     extras_require={
         "sphinx": [
-            "sphinx",
+            "sphinx>4,<=4.2.0", # TODO: unpin when sphinx-book-theme incompatibility is fixed
             "myst-parser",
             "sphinx-book-theme",
         ],
@kousu kousu added the bug Something isn't working label Nov 11, 2021
@welcome
Copy link

welcome bot commented Nov 11, 2021

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

kousu added a commit to kousu/sphinx-book-theme that referenced this issue Nov 11, 2021
@kousu
Copy link
Contributor Author

kousu commented Nov 11, 2021

Ah, upstream has caught and tried to deal with this already: pydata/pydata-sphinx-theme#509

kousu added a commit to kousu/sphinx-book-theme that referenced this issue Nov 11, 2021
Fixes executablebooks#427. Or..it should..but I'm not sure because executablebooks#428 makes me think what's in this repo is not making it out to pypi.
mergify bot pushed a commit to sgkit-dev/sgkit that referenced this issue Nov 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant