-
Notifications
You must be signed in to change notification settings - Fork 85
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 build failure on CI #1273
Comments
Looks like this is related to this issue on Sphinx: sphinx-doc/sphinx#8074 |
Re-opening: if the latest Sphinx from PyPI won't build the Traits documentation, that's a bug that should be investigated and fixed. (Even more so if the latest Sphinx from EDM won't build the Traits documentation.) |
Looks like Sphinx 3.2.1 has been released. We should check that it builds the Traits docs successfully, and if so, we may want to revert the pinned Sphinx version. |
On a broader topic, this does highlight once again the danger of unpinned dependent packages, even for something with as few dependencies as Traits. I'm wondering whether the right thing to do is to pin everything. It's not just about spurious PR failures caused by an upstream update - it's also about being able to recreate historical environments accurately when trying to reproduce old bugs, or when doing a |
The PR title probably should have been "avoid Sphinx 3.2.0" after the change to |
Okay, thanks. It probably makes sense to keep that, then, at least for now. I'd still like to double check that the build with 3.2.1 is okay before this issue gets reclosed. By the way: why was the |
Hmmm, it does look like it is no longer relevant to me, as CI |
Right, but this isn't just about CI: the ">= 2.1.0" restriction is a statement that the doc build requires a version of Sphinx that's at least 2.1.0. As far as I know, that's still true: the doc build will fail with Sphinx versions earlier than 2.1.0. It's fine to remove that restriction on the basis that that version of Sphinx is so old that no-one could conceivably still want to use it, but that's independent of fixing the problem with 3.2.0. IOW, I don't think PR #1276 should have changed this. (But it's done now, and it's probably not worth the effort of reinstating.) |
Recent CI builds (e.g., for #1296) have been using Sphinx 3.2.1 without issues, so I think we can close this. |
Documentation build on master is failing with the following error:
If I downgrade to Sphinx 3.1.2, then the build passes.
Currently this is causing CI builds for new pull requests to fail.
The text was updated successfully, but these errors were encountered: