10000 Circle CI should run when docstrings are modified · Issue #7815 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

Circle CI should run when docstrings are modified #7815

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
jnothman opened this issue Nov 3, 2016 · 5 comments
Closed

Circle CI should run when docstrings are modified #7815

jnothman opened this issue Nov 3, 2016 · 5 comments
Labels
Build / CI

Comments

@jnothman
Copy link
Member
jnothman commented Nov 3, 2016

Our documentation builder is currently not running unless files under doc/ or examples/ are modified (see https://github.com/scikit-learn/scikit-learn/blob/master/build_tools/circle/check_build_doc.py#L65). However, it can be worth compiling the docs to view docstrings, as in #7804. I suspect it'll be hard to check if a docstring is modified, but is it especially harmful to run the Circle CI build in all cases?
@lesteve
Copy link
Member
lesteve commented Nov 4, 2016

is it especially harmful to run the Circle CI build in all cases?

I guess the main problem is that it takes ages, right? Quickly looking at a few CircleCI build it is about 30-40 minutes to build the doc, so building it on each commit does not seem workable.

Maybe an intermediate solution would be to always run make html-noplot in CircleCI so that you can double-check docstrings if this use case arises reasonably often.

@jnothman
Copy link
Member Author
jnothman commented Nov 5, 2016

Yes, I'd support that.

On 4 November 2016 at 23:16, Loïc Estève notifications@github.com wrote:

is it especially harmful to run the Circle CI build in all cases?

I guess the main problem is that it takes ages, right? Quickly looking at
a few CircleCI build it is about 30-40 minutes to build the doc, so
building it on each commit does not seem workable.

Maybe an intermediate solution would be to always run make html-noplot in
CircleCI so that you can double-check docstrings if this use case arises
reasonably often.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#7815 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAEz60Q7FxuBTeYerqWhC7ntB7ZTb84sks5q6yI6gaJpZM4KoUCP
.

@amueller
Copy link
Member

So always html-noplot and if an example is change html?

@amueller amueller reopened this Nov 17, 2016
@lesteve
Copy link
Member
lesteve commented Nov 17, 2016 •
edited
Loading

So always html-noplot and if an example is change html?

Yeah I think that was the idea: always html-noplot and keep the current behaviour when to build the full doc with the examples (either an example changed or some rst in doc off the top of my head).

@amueller
Copy link
Member

👍

@jnothman jnothman mentioned this issue Nov 20, 2016
Merged
@jnothman jnothman mentioned this issue Nov 22, 2016
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Build / CI
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jnothman @amueller @lesteve
0