Furo is broken on Sphinx 7.2.0 and 7.2.1 #693
-
|
I have definitely not set |
Beta Was this translation helpful? Give feedback.
Replies: 10 comments 14 replies
-
|
I'm facing the same issue in this project. My Sphinx config is short extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.napoleon", # before sphinx_autodoc_typehints
"sphinx_autodoc_typehints",
]
autodoc_mock_imports = []
templates_path = []
source_suffix = ".rst"
master_doc = "index"
project = "..."
copyright = "..."
author = "..."
version = "X.Y"
release = "X.Y.Z"
language = "en"
pygments_style = "sphinx"
html_theme = "furo"
htmlhelp_basename = "foxplotdoc"Timeline:
So it is likely this started to happen recently. |
Beta Was this translation helpful? Give feedback.
-
|
I can also confirm that with Sphinx 7.1.2, our Furo-based documentation was fine, and with no change other than upgrading to Sphinx 7.2.0 we see the same error as @hynek reported:
|
Beta Was this translation helpful? Give feedback.
-
|
I've spent good 2+ hours trying to troubleshoot the same issue. Confirming it was sphinx v7.2.0, and I've just hit the time when it was released. |
Beta Was this translation helpful? Give feedback.
-
|
This is definitely due to Sphinx 7.2.0. When downgrading to 7.1.2, it works. |
Beta Was this translation helpful? Give feedback.
-
|
The contents of ['_static/pygments.css', '_static/styles/furo.css', '_static/custom.css', '_static/styles/furo-extensions.css']However, in Sphinx 7.2, it is a list of objects (that no longer inherit from [<sphinx.builders.html._assets._CascadingStyleSheet object at 0x107b2db30>, <sphinx.builders.html._assets._CascadingStyleSheet object at 0x107cbd8b0>,...]Each of those objects has a --- __init__.py.orig 2023-08-17 05:48:11.377444596 -0500
+++ __init__.py 2023-08-17 05:49:06.006422357 -0500
@@ -181,14 +181,15 @@
)
if "css_files" in context:
- if "_static/styles/furo.css" not in context["css_files"]:
+ css_files = [getattr(c, 'filename', c) for c in context['css_files']]
+ if "_static/styles/furo.css" not in css_files:
raise Exception(
"This documentation is not using `furo.css` as the stylesheet. "
"If you have set `html_style` in your conf.py file, remove it.",
)
_add_asset_hashes(
- context["css_files"],
+ css_files,
["styles/furo.css", "styles/furo-extensions.css"],
)
if "scripts" in context: |
Beta Was this translation helpful? Give feedback.
-
|
Actually, from looking at that sphinx commit, the |
Beta Was this translation helpful? Give feedback.
-
|
I confirm this issue too. Downgrading |
Beta Was this translation helpful? Give feedback.
-
|
Here's a complete reproduction case: |
Beta Was this translation helpful? Give feedback.
-
|
Sphinx 7.2.1 has been released, please test with the new release. |
Beta Was this translation helpful? Give feedback.
-
|
Still the same "This documentation is not using |
Beta Was this translation helpful? Give feedback.
-
|
Ahh, I see the problem -- |
Beta Was this translation helpful? Give feedback.
-
|
Sphinx 7.2.2 has been released, which should fix the issue on older versions of Furo. |
Beta Was this translation helpful? Give feedback.
-
|
Thank you, not getting the error with 7.2.2. |
Beta Was this translation helpful? Give feedback.
-
|
Fixed in 9b94420. If folks can test with that, that would be appreciated (https://pradyunsg.me/furo/contributing/workflow/#installing-directly-from-github)! :) The release is going to have to wait though, until I get home in about an hour. |
Beta Was this translation helpful? Give feedback.
-
|
According to this commit, minimal sphinx version in dependencies should be 7.2 |
Beta Was this translation helpful? Give feedback.
-
|
@dolfinus Sphinx was previously creating |
Beta Was this translation helpful? Give feedback.
-
|
The error seems to persist for me: https://readthedocs.org/projects/tespy/builds/21647449/ From the log: using furo in the version of the latest commit plus mine (#704) I get the same error as mentioned initially by hynek. |
Beta Was this translation helpful? Give feedback.
-
|
Your build is actually using Sphinx 6.1.2: For me, it worked to pin the Sphinx version to 7.1.2 (because 7.2.x isn't compatible with the notfound extension). |
Beta Was this translation helpful? Give feedback.
-
|
Ah, thanks a lot! The issue with that seems to be, that the sphinx-rtd-theme was still installed although I do not need or use it. Pinning sphinx to >= 7.2.2 did the trick: https://readthedocs.org/projects/tespy/builds/21649696/. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks to @AA-Turner for the quick fix on Sphinx's end for this. As always, the work that you're doing to improve foundational pieces in the Sphinx ecosystem are appreciated! ❤️ I've also released the aforementioned change, in case it makes things easier for the behaviours that Sphinx has planned. :) |
Beta Was this translation helpful? Give feedback.
-
|
Also an issue with Sphinx 6.2.1 (yes I will be updating to 7.2.2) |
Beta Was this translation helpful? Give feedback.
-
|
Hmm... This was a subtle comment -- it ended up being #716. |
Beta Was this translation helpful? Give feedback.
-
|
With the release today, I think all the known incompatibility issues with various Sphinx releases should be resolved (this is also tested with automation now, which is a good thing). |
Beta Was this translation helpful? Give feedback.
With the release today, I think all the known incompatibility issues with various Sphinx releases should be resolved (this is also tested with automation now, which is a good thing).