8000 DOC: Sphinx WARNING: autodoc: failed to import function from module · Issue #15331 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content
8000

DOC: Sphinx WARNING: autodoc: failed to import function from module #15331

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.

Sign up for GitHub

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

Jump to bottom
Closed
cmarmo opened this issue Oct 22, 2019 · 1 comment · Fixed by #15343
Closed

DOC: Sphinx WARNING: autodoc: failed to import function from module #15331

cmarmo opened this issue Oct 22, 2019 · 1 comment · Fixed by #15343

Comments

@cmarmo
Copy link
Contributor
cmarmo commented Oct 22, 2019 •
edited
Loading

This is the last Sphinx warning:
WARNING: autodoc: failed to import function 'cholesky_delete' from module 'arrayfuncs'; the following exception was raised: No module named 'arrayfuncs'
It was already raised in #13380.

Thanks to @grisel and @jeremiedbb the responsible has been identified.
Apparently the cython type of the cholesky_delete function (fused function) makes sphinx misbehave with respect to the sphinx function template.

Sphinx can't link correctly the cholesky_delete function: see here and for comparison the min_pos rendering and the cholesky_delete rendering.

A simple solution is to just remove cholesky_delete from documentation, considering that cholesky_delete is already undocumented and a reorganisation of utils is ongoing making private a number of public functions (#6616, #15223, #15225).

If you do not agree with this solution I will investigate more into sphinx and cython incompatibility... However, I hope you agree, as I could propose a PR.
@thomasjpfan
Copy link
Member

I am okay with removing cholesky_delete from the documentation.

@cmarmo cmarmo mentioned this issue Oct 23, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC Remove 'cholesky_delete' from toc (fix sphinx autodoc warning). cmarmo/scikit-learn
2 participants
@cmarmo @thomasjpfan
0