BUG Copy Binder logo to avoid Window drive rel path error #745

lucyleeow · 2020-09-05T20:50:13Z

Fixes #744

Copy Binder logo from package _static folder to target_dir/images.

@larsoner happy to explore another solution.

Test: would changing appveyor setup such that _static is in a different drive be a good test? I am not so familiar with appveyor but if I add a cd D: here:

sphinx-gallery/appveyor.yml

Lines 28 to 29 in 839c02b

    
           test_script: 
        
             - python setup.py develop

would that work?

larsoner · 2020-09-06T01:00:44Z

I suspect you shouldn't need to manually copy any static file, just link to it properly. The question is how to do that. Usually / hopefully you can do it by doing a relpath between the example file and the src_dir or so (?), or maybe get the static path from Sphinx. I can dig into it Tuesday if we can wait that long

lucyleeow · 2020-09-06T09:04:31Z

The problem is that relative paths between 2 different drives on Windows doesn't exist. It may be possible with symbolic links but we might not want to mess with that.

(I think I tried using a static path but it didn't work - though I didn't look into this too closely)

No hurry, take a look on Tuesday.

codecov · 2020-09-06T15:05:46Z

Codecov Report

Merging #745 into master will increase coverage by 0.00%.
The diff coverage is 97.29%.

@@           Coverage Diff           @@
##           master     #745   +/-   ##
=======================================
  Coverage   97.50%   97.51%           
=======================================
  Files          32       32           
  Lines        3727     3741   +14     
=======================================
+ Hits         3634     3648   +14     
  Misses         93       93

Impacted Files	Coverage Δ
sphinx_gallery/tests/test_gen_rst.py	`99.71% <ø> (ø)`
sphinx_gallery/tests/test_notebook.py	`100.00% <ø> (ø)`
sphinx_gallery/tests/test_full.py	`99.57% <92.30%> (-0.21%)`	⬇️
sphinx_gallery/binder.py	`96.11% <100.00%> (+0.97%)`	⬆️
sphinx_gallery/gen_gallery.py	`94.90% <100.00%> (+0.01%)`	⬆️
sphinx_gallery/tests/test_binder.py	`98.85% <100.00%> (+0.08%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 839c02b...3518ece. Read the comment docs.

larsoner · 2020-09-08T16:30:30Z

@lucyleeow pushed a commit. The critical point is that, regardless of what html_static_paths users enter, they always end up in _static/. So we just need to link directly to OUT_DIR/_static/image.svg. See if it makes sense and if so, feel free to merge and cut a 0.8.1

lucyleeow · 2020-09-08T16:45:07Z

I think I've just missed something important. So all files in the package _static dir (i.e. <where you installed SG>/sphinx-gallery/sphinx_gallery/_static) are always copied over to the built html (e.g., <where your package is>/doc/_build/html/_static/)?

Can you show me where this is done in the code?

larsoner · 2020-09-08T16:47:15Z

Can you show me where this is done in the code?

It's done by sphinx itself somewhere (feel free to dig through their code to figure this out). If you look at tinybuild I modified it to use html_static_paths = ['_static_nonstandard'], but when you make html, the static files from that dir and from glr_path_static (because we add it to the static paths) get copied to OUT_DIR/_static. AFAIK this is a hard-coded output path

lucyleeow · 2020-09-08T16:48:07Z

Thanks, I had no idea Sphinx did this but it makes sense.

larsoner · 2020-09-08T16:48:38Z

Feel free to fix the path error in CIs, or I can push a fix in a couple of hours. Have meetings now

larsoner · 2020-09-08T16:54:28Z

Actually I think that all of those build warnings are bogus, they say files don't exist but it renders fine:

https://1811-25860190-gh.circle-artifacts.com/0/rtd_html/auto_examples/plot_0_sin.html#sphx-glr-auto-examples-plot-0-sin-py

I'm not sure how to avoid this warning. Maybe worth asking on the Sphinx listserv or GitHub. But we do need to make these warnings go away somehow because this will cause -nW builds fail. :(

larsoner · 2020-09-08T16:56:28Z

This might also be relevant

#120

And maybe

https://stackoverflow.com/questions/52138336/sphinx-reference-to-an-image-from-different-locations#answer-52141199

lucyleeow · 2020-09-08T18:14:53Z

I'll do this tomorrow

larsoner · 2020-09-08T18:24:19Z

Actually I wonder if the correct fix is to give the path to the sphx_glr_static() without any relpath business. Sphinx in theory should recognize that this is a path to a static file and substitute OUT_DIR/static. I'll give it a shot...

larsoner · 2020-09-09T14:29:33Z

Okay @lucyleeow I ended up giving up on the static idea and ended up with something that I think is pretty close to what you had. Can you take a look and merge if you're happy?

lucyleeow · 2020-09-09T14:30:04Z

sphinx_gallery/binder.py

+        os.path.dirname(fpath), 'images', 'binder_badge_logo.svg')
+    os.makedirs(os.path.dirname(physical_path), exist_ok=True)
+    if not os.path.isfile(physical_path):
+        shutil.copyfile(


I think for the test test_gen_binder_rst we shouldn't copy the file over

Nevermind, isfile is better than os.path.exists that I used.

I'll try some tmpdir gymnastics...

lucyleeow · 2020-09-09T14:38:10Z

Sorry can you clarify what glr_path_static returns? Is it the packaged _static, where the package files are or the path to the the _static folder where the built html files are?

lucyleeow · 2020-09-09T14:42:22Z

sphinx_gallery/tests/test_binder.py

@@ -115,9 +116,10 @@ def apptmp():
    assert url == expected


-def test_gen_binder_rst():
+def test_gen_binder_rst(tmpdir):
    """Check binder rst generated correctly."""
    gallery_conf_base = {'gallery_dirs': None, 'src_dir': 'blahblah'}


I set 'gallery_dirs': None to avoid copying files over when testing (with my poor implementation), but we can change this back to what it was before

Pushed a commit to be more like how it should in actually building

larsoner · 2020-09-09T14:45:02Z

glr_path_static is the path to sphinx-gallery's sphinx_gallery/_static folder. The contents will be copied to OUT_DIR/_static on build. The problem is that we can't actually use it (see code comments)

lucyleeow · 2020-09-09T14:55:29Z

Okay thanks. But in Windows, if the path has to be relative to the build root, and the build root is in a different drive to glr_path_static, I thought there was not relative path between different drives?
Sorry maybe I missed something?

larsoner · 2020-09-09T15:18:41Z

Sorry maybe I missed something?

relpath is no longer used

lucyleeow · 2020-09-09T15:37:52Z

sphinx_gallery/tests/test_full.py

@@ -445,7 +444,8 @@ def test_rebuild(tmpdir_factory, sphinx_app):
        new_app.build(False, [])
    status = new_app._status.getvalue()
    lines = [line for line in status.split('\n') if '0 removed' in line]
-    assert re.match('.*[0|1] added, [1-9] changed, 0 removed$.*',
+    # XXX on AppVeyor this can be 13


What can be 13?

The number of changed files in the regex below

Ah okay. DI]id this change?

It did in previous runs because I added binder to the tinybuild conf. Not sure if it's still there or not but I'm okay living with it

Ahh I forgot binder changed. Can we change to:
assert re.match('.*[0|1] added, [1-9][0-3]? changed, 0 removed$.*',

Sure, feel free to push. You could even make the [1-9][0-3]? only if on windows and use [1-9] otherwise

lucyleeow added 8 commits September 1, 2020 21:13

binder logo

b295625

add test

a64b210

add logo

9f8bd25

remove print

20ab7a8

fix test

3b18269

lint

35aaf6b

merge master

be58265

merge master

2ae3bb2

lucyleeow added the bug label Sep 5, 2020

BUG: Better static path

d94d2f4

FIX: Path

d6013d6

larsoner added 4 commits September 8, 2020 15:55

FIX: Direct route

d266f51

FIX: Minimize diff

cd5ecdb

FIX: Correctly

21a9e63

FIX: Flexible

610c532

lucyleeow mentioned this pull request Sep 9, 2020

sphinx_gallery/tests/test_full.py::test_binder_logo_exists fails (path is clearly wrong) #746

Closed

larsoner added 2 commits September 9, 2020 09:18

FIX: Codecs

ce1012c

FIX: Different path on Windows

c628104

larsoner added 2 commits September 9, 2020 09:42

FIX: Try again

1505f63

FIX: Give up

b6e42be

lucyleeow commented Sep 9, 2020

View reviewed changes

FIX: in tmpdir

fbc9191

lucyleeow commented Sep 9, 2020

View reviewed changes

FIX: gallery_dirs

34c59b5

FIX: Old

460d799

FIX: Again

9e3ed1a

wording nitpick

5d9bd7e

lucyleeow commented Sep 9, 2020

View reviewed changes

lucyleeow added 2 commits September 9, 2020 17:52

revert blank space

fcbfe1e

amend changed

3518ece

lucyleeow merged commit 7bac6f5 into sphinx-gallery:master Sep 9, 2020

lucyleeow deleted the IS/744 branch September 9, 2020 20:00

lucyleeow mentioned this pull request Oct 22, 2020

ENH: Add run_stale_examples config var #759

Merged

BUG Copy Binder logo to avoid Window drive rel path error #745

BUG Copy Binder logo to avoid Window drive rel path error #745

Uh oh!

Conversation

lucyleeow commented Sep 5, 2020

Uh oh!

larsoner commented Sep 6, 2020

Uh oh!

lucyleeow commented Sep 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Sep 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

larsoner commented Sep 8, 2020

Uh oh!

lucyleeow commented Sep 8, 2020

Uh oh!

larsoner commented Sep 8, 2020

Uh oh!

lucyleeow commented Sep 8, 2020

Uh oh!

larsoner commented Sep 8, 2020

Uh oh!

larsoner commented Sep 8, 2020

Uh oh!

larsoner commented Sep 8, 2020

Uh oh!

lucyleeow commented Sep 8, 2020

Uh oh!

larsoner commented Sep 8, 2020

Uh oh!

larsoner commented Sep 9, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lucyleeow commented Sep 9, 2020

Uh oh!

lucyleeow Sep 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

larsoner commented Sep 9, 2020

Uh oh!

lucyleeow commented Sep 9, 2020

Uh oh!

larsoner commented Sep 9, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lucyleeow commented Sep 6, 2020 •

edited

Loading

codecov bot commented Sep 6, 2020 •

edited

Loading

lucyleeow Sep 9, 2020 •

edited

Loading