Skip to content

Conversation

@sciunto sciunto changed the title Fix deprecated option Fix deprecated option in sphinx that causes warning treated as error in travis Dec 8, 2016
@sciunto sciunto requested a review from soupault December 8, 2016 10:47
@sciunto sciunto added 🔧 type: Maintenance Refactoring and maintenance of internals 🧐 Needs review labels Dec 8, 2016
soupault
soupault previously approved these changes Dec 8, 2016
Copy link
Member

@soupault soupault left a comment

Choose a reason for hiding this comment

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

Thanks!

@sciunto
Copy link
Member Author

sciunto commented Dec 8, 2016

Looks like there is several evolutions in sphinx.

Right now, I have this message

Exception occurred:

  File "/home/travis/build/scikit-image/scikit-image/doc/source/../ext/sphinx_gallery/docs_resolv.py", line 48, in _get_data

    with open(url, 'r') as fid:

IOError: [Errno 2] No such file or directory: '/home/travis/build/scikit-image/scikit-image/doc/build/html/api/skimage.color.rst.html'

The full traceback has been saved in /tmp/sphinx-err-yAUWXd.log, if you want to report the issue to the developers.

Please also report this if it was a user error, so that a better error message can be provided next time.

A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

It deserves some investigations... ping @sphinx-gallery (not sure if this is relevant: sphinx-gallery/sphinx-gallery#58)

@JDWarner
Copy link
Contributor

Sphinx broke this in version 1.5, their logic for warning checking has (had) a typo. I reported it here and it's now fixed in master: sphinx-doc/sphinx#3204

The workaround is either to use Sphinx from master until they release a version with the fix, or allow Travis to pass with Sphinx errors in the interim.

@sciunto
Copy link
Member Author

sciunto commented Dec 12, 2016

Thanks @JDWarner for your comment but actually, I already went through that one, no? (And i didn't noticed the typo). My problem is more with sphinx-gallery now.

@sciunto
Copy link
Member Author

sciunto commented Dec 13, 2016

I updated sphinx-gallery, a bug fix release for sphinx 1.5.

@emmanuelle
Copy link
Member

Thanks @sciunto ! For the sphinx-gallery files, did you copy them from the latest sphinx-gallery release (or from master), or is there some divergence between the files in scikit-image and the ones in sphinx-gallery ?

@sciunto
Copy link
Member Author

sciunto commented Dec 20, 2016

@emmanuelle I copied them, and I didn't modify any of them.

@emmanuelle
Copy link
Member

OK, great. At some point we can consider adding sphinx-gallery as a dependency, but there's no hurry to do it. Two questions:

  • any idea why Travis still fails?
  • with the new sphinx-gallery, did you build the gallery to check that it still looks good?

@sciunto
Copy link
Member Author

sciunto commented Dec 20, 2016

@emmanuelle Did you read the ticket I opened upstream? Before going into more investigations, we were wondering if there was modifications that you brought in our copy of sphinx gallery that were not included upstream? I guess you would never have done that, except perhaps by mistake...

@sciunto
Copy link
Member Author

sciunto commented Dec 20, 2016

PS: the problem also exists on my desktop. Nevertheless, the gallery looks good as it happens at the very end for the generation of hyperlinks.

@emmanuelle
Copy link
Member

@sciunto is it sphinx-gallery/sphinx-gallery#184? When I ported the gallery to sphinx-gallery (#2078) I had to modify at least one file but I back-ported it to sphinx-gallery (sphinx-gallery/sphinx-gallery#119, which has been merged).

@emmanuelle
Copy link
Member

As suggested by @JDWarner should we allow Travis to pass with sphinx warnings until the problem is solved? It's blocking a number of PRs in the meantime...

@sciunto
Copy link
Member Author

sciunto commented Dec 21, 2016

Thanks for the clarifications @emmanuelle

We can do that. I don't know where is this option to do not treat warning as errors. If you give me a hint, I can do it in this PR. At least, this PR solves problems related to our configuration and the latest sphinx evolutions. It could be merged imho. For the rest, upstream is currently looking at it. I can open another ticket to follow the progress.

@sciunto
Copy link
Member Author

sciunto commented Dec 21, 2016

A patch is in the pipes...

@sciunto
Copy link
Member Author

sciunto commented Dec 21, 2016

@emmanuelle @soupault The build goes fine on my side. Ready to go!

@sciunto sciunto added 📄 type: Documentation Updates, fixes and additions to documentation 🧐 Needs review and removed 💪 Work in progress labels Dec 21, 2016
@codecov-io
Copy link

codecov-io commented Dec 21, 2016

Current coverage is 90.64% (diff: 100%)

No coverage report found for master at 9d7fcca.

Powered by Codecov. Last update 9d7fcca...eac6f6a

@soupault soupault self-assigned this Dec 22, 2016
@Borda
Copy link
Contributor

Borda commented Dec 22, 2016

it seems ready to merge, right? :)

@sciunto
Copy link
Member Author

sciunto commented Dec 22, 2016

Let's ping @scikit-image/core to see if someone can press the green button :)

@soupault soupault dismissed their stale review December 22, 2016 12:59

Outdated

"""
import os
__version__ = '0.1.2'
__version__ = '0.1.7'
Copy link
Member

Choose a reason for hiding this comment

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

If I understood correctly, the update in this PR contains sphinx-gallery 0.1.7+sphinx-gallery/sphinx-gallery#190 .
If it is indeed so, I'd suggest either to wait for that patch being merged, or to note somewhere the details regarding the version used.

Copy link
Member

Choose a reason for hiding this comment

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

I think it's more urgent to have Travis passing again.

@sciunto
Copy link
Member Author

sciunto commented Dec 22, 2016

@soupault My plan is to re-update sphinx-gallery before the release... I open a ticket for that, assigned to myself.

@sciunto
Copy link
Member Author

sciunto commented Dec 22, 2016

The idea is to be get travis back to work for other PRs.

@emmanuelle
Copy link
Member

@sciunto in addition to the open ticket, can you add a line in TODO.txt as well?

@sciunto
Copy link
Member Author

sciunto commented Dec 22, 2016

Oki, it's done :)

Copy link
Member

@emmanuelle emmanuelle left a comment

Choose a reason for hiding this comment

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

LGTM!

@emmanuelle emmanuelle merged commit 5997cb0 into scikit-image:master Dec 23, 2016
@emmanuelle
Copy link
Member

Merging, thanks!

@soupault
Copy link
Member

LGTM as well.

@sciunto sciunto deleted the sphinx_option branch December 23, 2016 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🧐 Needs review 📄 type: Documentation Updates, fixes and additions to documentation 🔧 type: Maintenance Refactoring and maintenance of internals

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants