-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Autosummary fails on NumPy with 3.4.0 #8566
Labels
Milestone
Comments
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Dec 23, 2020
…s classes On the refactoring of Documenter.add_content() method, the autodoc-process-docstring event is emitted to the alias classes (called as doc_as_attr in our code) unexpectedly. Before the change, it has never been emitted. The event causes that extensions (ex. numpydoc) confused. So this reverts the change temporarily (during 3.4.x).
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Dec 23, 2020
…s classes On the refactoring of Documenter.add_content() method, the autodoc-process-docstring event is emitted to the alias classes (called as doc_as_attr in our code) unexpectedly. Before the change, it has never been emitted. The event causes that extensions (ex. numpydoc) confused. So this reverts the change temporarily (during 3.4.x). refs: sphinx-doc#8533
Finally, I found this bug came from the bug of autodoc. On my local, #8581 resolves this issue. Note: reproducible Dockerfile
|
With pandas we had the same issue (see #8533 (comment)), and I can confirm that #8581 fixes it. Thanks for the quick follow-up! |
@jorisvandenbossche Thank you for confirmation! |
tk0miya
added a commit
that referenced
this issue
Dec 24, 2020
…for_alias_classes Fix #8566: autodoc-process-docstring is emitted to the alias classes
Thanks for the fix. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
The new 3.4.0 release does not properly import in autosummary docstrings. We get lots of errors like
To Reproduce
checkout numpy,
pip install cython; pip install .; pip install -r doc_requirements.txt; cd doc; make html
Expected behavior
3.3.1 worked fine. 3.4.0 fails with many
fail to import ...
and thenHere is the complete log
log.txt
The text was updated successfully, but these errors were encountered: