-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
Make sphinx build without warnings, let circle IO error on warnings #6025
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
Comments
@amueller Which sphinx warnings do you have in mind? There seem to be quite a few of them:
There are also things like
which I do not think is really a good reason for breaking a build. In any case I am happy to implement whatever you decide would is best! |
these are easy to fix failures. The current mode is that these errors accumulate and before the release I spend half a week on fixing these. There is things like
|
@amueller Those errors you pointed out are probably easy to fix but I am not sure how to fix problems with document not being included in any toctree. Thanks for the clarification, I'll start by fixing those easy issues and updating the test script. |
there is some issue about how the datasets are included. there is a part in the index that has a hidden toc for inclusion. |
Fix in #6030. "Need Contrib" tag to be removed |
We should fix the remaining sphinx warnings here:
https://circleci.com/gh/scikit-learn/scikit-learn/1629
and then make circle IO error if there are any warnings (grep'ing for
WARNINGS
I guess?).This way we immediately see if someone broke anything in the docs.
The text was updated successfully, but these errors were encountered: