Skip to content
This repository has been archived by the owner on May 25, 2022. It is now read-only.

build_sphinx now checks for "build succeeded." on any line. #223

Merged
merged 3 commits into from
Apr 15, 2016

Conversation

Cadair
Copy link
Member

@Cadair Cadair commented Mar 29, 2016

This is to work around the effects of sphinx-gallery which prints
information about the gallery build out after the "build succeeded."
message.

The output from a sphinx-gallery build looks like this:

copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded.
Embedding documentation hyperlinks in examples..
    processing: index.html
    processing: plot_aia_example.html
[done]
The build_sphinx travis build FAILED because sphinx issued documentation warnings (scroll up to see the warnings).

This effects astropy/astropy#4734 and sunpy/sunpy#1718.

ping @adrn @eteq

This is to work around the effects of sphinx-gallery which prints
information about the gallery build out after the "build succeeded."
message.
@Cadair
Copy link
Member Author

Cadair commented Apr 14, 2016

The CI fails on this do not seem to be my fault?

@pllim
Copy link
Member

pllim commented Apr 14, 2016

Hmm, but why would coverage decrease?

@Cadair
Copy link
Member Author

Cadair commented Apr 14, 2016

not a clue!!

@eteq
Copy link
Member

eteq commented Apr 14, 2016

Yep, the failures are unrelated (#222). The coverage change is real - if you look at the details it's one-line, because the coverage stuff is only looking at a small chunk of the actual code. I'm not worried about it, though.

@Cadair, can you confirm that you tested this on either astropy or sunpy and it worked? (Also, that it didn't produce any false positives?)

@Cadair
Copy link
Member Author

Cadair commented Apr 14, 2016

I tested it on the sunpy gallery build and it worked. I have not tested it on a build with warnings.

@bsipocz
Copy link
Member

bsipocz commented Apr 15, 2016

👍 on getting this merged.

@eteq @Cadair - I've tested it on a build with warnings and it still returns nonzero exit code.

@bsipocz
Copy link
Member

bsipocz commented Apr 15, 2016

However, after having a second look, it seems that more builds are failing than in master, so would be nice to investigate and fix this: https://travis-ci.org/astropy/astropy-helpers/jobs/119195000

@eteq
Copy link
Member

eteq commented Apr 15, 2016

Good catch @bsipocz - it appears this is specifically a py 3.x problem... That is, the failure you're noting happens in 3.3,3.4,and 3.5, but not 2.6 or 2.7...

@eteq
Copy link
Member

eteq commented Apr 15, 2016

Aha, I think I figured it out. @Cadair, if you merge Cadair#1, I think that will do the trick and then this will be good to merge.

switch to checking decoded version for build success message
@Cadair
Copy link
Member Author

Cadair commented Apr 15, 2016

ah of course!

@eteq
Copy link
Member

eteq commented Apr 15, 2016

Looks like that did the job - there's a new failure, but it's a red herring (internet hiccup), so I'll just go ahead and merge this.

(will add a changelog entry about this when I merge)

@eteq eteq added this to the v1.1.3 milestone Apr 15, 2016
@bsipocz
Copy link
Member

bsipocz commented Apr 15, 2016

@eteq - while you're at it, you may also want to look at #225.

@eteq eteq merged commit 237d284 into astropy:master Apr 15, 2016
eteq added a commit that referenced this pull request Apr 15, 2016
build_sphinx now checks for "build succeeded." on any line.
@Cadair
Copy link
Member Author

Cadair commented Apr 15, 2016

REJOICE!

@Cadair
Copy link
Member Author

Cadair commented Apr 19, 2016

Could this get in a bugfix release?

eteq added a commit to astropy/astropy that referenced this pull request May 14, 2016
this is necessary to keep the sphinx-gallery from causing travis builds to fail (see astropy/astropy-helpers#223)
@astrofrog astrofrog modified the milestones: v1.2, v1.1.3 Jun 2, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants