8000 Revert "ENH Patches sphinx.ext.autosummary for case insensitive file … by thomasjpfan · Pull Request #17780 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

Revert "ENH Patches sphinx.ext.autosummary for case insensitive file … #17780

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
Merged
merged 1 commit into from
Jul 1, 2020
Merged

Revert "ENH Patches sphinx.ext.autosummary for case insensitive file … #17780

merged 1 commit into from
Jul 1, 2020

Conversation

thomasjpfan
Copy link
Member
@thomasjpfan thomasjpfan commented Jun 29, 2020 •
edited
Loading

Fixes #17771

Either we revert the patch or we ignore the warning caused by autosummary.

I wish there was a way to resolve this issue so we can move forward with #17564

@glemaitre @adrinjalali

@jnothman
Copy link
Member
jnothman commented Jun 29, 2020 via email

@thomasjpfan
Copy link
Member Author

Here is the issue I forgot to link: #17771

The warning is:

ARNING: the custom_autosummary_new_suffix extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit
WARNING: doing serial read
/home/glemaitre/Documents/packages/scikit-learn/doc/modules/classes.rst.rst:115: WARNING: autosummary: stub file not found 'sklearn.cluster.dbscan'. Check your autosummary_generate setting.
/home/glemaitre/Documents/packages/scikit-learn/doc/modules/classes.rst.rst:184: WARNING: autosummary: stub file not found 'sklearn.covariance.oas'. Check your autosummary_generate setting.
/home/glemaitre/Documents/packages/scikit-learn/doc/modules/classes.rst.rst:325: WARNING: autosummary: stub file not found 'sklearn.decomposition.fastica'. Check your autosummary_generate setting.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/glemaitre/Documents/packages/scikit-learn/doc/modules/generated/sklearn.cluster.dbscan-lowercase.rst: WARNING: document isn't included in any toctree
/home/glemaitre/Documents/packages/scikit-learn/doc/modules/generated/sklearn.covariance.oas-lowercase.rst: WARNING: document isn't included in any toctree
/home/glemaitre/Documents/packages/scikit-learn/doc/modules/generated/sklearn.decomposition.fastica-lowercase.rst: WARNING: document isn't included in any toctree
done
preparing documents... done

@maikia maikia mentioned this pull request Jun 30, 2020
Merged
@adrinjalali
Copy link
Member

I'd be happy to ignore the warnings for now if we can fix this upstream.

@thomasjpfan
Copy link
Member Author

Unfortunately, I am not familiar with sphinx enough to think of a good solution upstream. Autosummary would need another way to figure out "if a file has been processed" that does not rely on the filesystem.

I would want to revert this so the CI does not fail. Here is the warning we are getting from sphinx.

@rth
Copy link
Member
rth commented Jul 1, 2020

OK, let's revert for now. Thanks @thomasjpfan !

@rth rth merged commit 903c82e into scikit-learn:master Jul 1, 2020
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Jul 17, 2020
@thomasjpfan @glemaitre
Revert "ENH Patches sphinx.ext.autosummary for case insensitive file …
7a53c76 
…systems (scikit-learn#13022)" (scikit-learn#17780)

This reverts commit 8a695d7.
jayzed82 pushed a commit to jayzed82/scikit-learn that referenced this pull request Oct 22, 2020
@thomasjpfan @jayzed82
Revert "ENH Patches sphinx.ext.autosummary for case insensitive file …
12da2c2 
…systems (scikit-learn#13022)" (scikit-learn#17780)

This reverts commit 8a695d7.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jnothman jnothman jnothman approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Sphinx issue with autosummary
4 participants
@thomasjpfan @jnothman @adrinjalali @rth
0