10000 [MRG+1] Run sphinxext doctests only on CircleCI by lesteve · Pull Request #8228 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

[MRG+1] Run sphinxext doctests only on CircleCI #8228

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
Jan 25, 2017
Merged

[MRG+1] Run sphinxext doctests only on CircleCI #8228

merged 1 commit into from
Jan 25, 2017

Conversation

lesteve
Copy link
Member
@lesteve lesteve commented Jan 24, 2017 •
edited
Loading

Building the documentation on CircleCI is a better test. Also doctests are generally not very extensive tests and sphinx extensions in doc/sphinxext are third party libraries and we should not be the ones testing it.

sphinx extensions may have dependencies, e.g. sphinx.

Discussed in #8222 (comment). ping @jnothman.

jnothman
jnothman reviewed Jan 24, 2017
View reviewed changes
Copy link
Member
@jnothman jnothman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still think it's worth running test-sphinxext somewhere, but on Circle, perhaps not in the main tests.

@lesteve lesteve force-pushed the remove-test-sphinxext branch from 655a942 to 65052e1 Compare January 24, 2017 12:16
@lesteve
Copy link
Member Author
lesteve commented Jan 24, 2017

I still think it's worth running test-sphinxext somewhere, but on Circle, perhaps not in the main tests.

Hmm I made the change without being really convinced. IMO we are very unlikely to find problems in sphinx extensions through doctests.

@lesteve lesteve force-pushed the remove-test-sphinxext branch from 65052e1 to a658648 Compare January 24, 2017 13:42
@lesteve lesteve changed the title [MRG] Remove test-sphinxext from the Makefile [MRG] Run test-sphintext only on CircleCI Jan 24, 2017
@lesteve lesteve changed the title [MRG] Run test-sphintext only on CircleCI [MRG] Run sphinxext doctests only on CircleCI Jan 24, 2017
@lesteve lesteve force-pushed the remove-test-sphinxext branch from 797e28b to 8328a7f Compare January 24, 2017 15:52
@lesteve
Test sphinx extensions doctests only on Circle.
e790fe4 
Some sphinx extensions import sphinx in their doctests.
@lesteve lesteve force-pushed the remove-test-sphinxext branch from 8328a7f to e790fe4 Compare January 24, 2017 18:07
@lesteve
Copy link
Member Author
lesteve commented Jan 24, 2017

This should be green now, I had to overcome some idiosyncrasies of CircleCI (mostly that each command is run in a separate shell, so you have to reactivate the conda env in each command).

jnothman
jnothman approved these changes Jan 24, 2017
View reviewed changes
Copy link
Member
@jnothman jnothman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jnothman jnothman changed the title [MRG] Run sphinxext doctests only on CircleCI [MRG+1] Run sphinxext doctests only on CircleCI Jan 24, 2017
TomDLT
TomDLT approved these changes Jan 25, 2017
View reviewed changes
Copy link
Member
@TomDLT TomDLT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@TomDLT TomDLT merged commit fdfdbf0 into scikit-learn:master Jan 25, 2017
@TomDLT TomDLT mentioned this pull request Jan 25, 2017
Merged
@lesteve lesteve deleted the remove-test-sphinxext branch January 30, 2017 08:08
sergeyf pushed a commit to sergeyf/scikit-learn that referenced this pull request Feb 28, 2017
@lesteve @sergeyf
Test sphinx extensions doctests only on Circle. (scikit-learn#8228)
6bfe0a6 
Some sphinx extensions import sphinx in their doctests.
@Przemo10 Przemo10 mentioned this pull request Mar 17, 2017
Closed
Sundrique pushed a commit to Sundrique/scikit-learn that referenced this pull request Jun 14, 2017
@lesteve @Sundrique
Test sphinx extensions doctests only on Circle. (scikit-learn#8228)
4b7e40d 
Some sphinx extensions import sphinx in their doctests.
NelleV pushed a commit to NelleV/scikit-learn that referenced this pull request Aug 11, 2017
@lesteve @NelleV
Test sphinx extensions doctests only on Circle. (scikit-learn#8228)
ca57482 
Some sphinx extensions import sphinx in their doctests.
paulha pushed a commit to paulha/scikit-learn that referenced this pull request Aug 19, 2017
@lesteve @paulha
Test sphinx extensions doctests only on Circle. (scikit-learn#8228)
250c7ee 
Some sphinx extensions import sphinx in their doctests.
maskani-moh pushed a commit to maskani-moh/scikit-learn that referenced this pull request Nov 15, 2017
@lesteve @maskani-moh
Test sphinx extensions doctests only on Circle. (scikit-learn#8228)
821d6f6 
Some sphinx extensions import sphinx in their doctests.
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

@TomDLT TomDLT TomDLT 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.
3 participants
@lesteve @jnothman @TomDLT
0