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

New sphinx version 3.0.0 breaks docs #265

Open
shukon opened this issue Apr 9, 2020 · 1 comment
Open

New sphinx version 3.0.0 breaks docs #265

shukon opened this issue Apr 9, 2020 · 1 comment

Comments

@shukon
Copy link
Collaborator

shukon commented Apr 9, 2020

New sphinx version breaks building of docs...
https://www.sphinx-doc.org/en/master/changes.html#release-3-0-0-released-apr-06-2020

Fixed for now by enforcing sphinx version 2.4.4

@shukon shukon added the bug label May 24, 2020
@shukon shukon changed the title New sphinx version 3.0.0 breaks docs-building New sphinx version 3.0.0 breaks docs Jun 13, 2020
@shukon
Copy link
Collaborator Author

shukon commented Jun 13, 2020

While this is not a critical bug by any means, it is annoying. To elaborate a little, reproduce:

$ pip install --upgrade matplotlib pillow sphinx sphinx-gallery sphinx_rtd_theme
$ cd docs
$ make buildapi
$ make html
sphinx-build -b html -d build/doctrees   . build/html
Running Sphinx v3.1.0
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 34 changed, 0 removed
Reading sources... [ 73%] apidoc/cave.cavefacade  

and there it freezes. Varies for the percentage, but always cave.cavefacade or cave.utils.timing.
On investigation, the line from functools import wraps is responsible. Commenting it out in both files results in successfully building docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant