DOC: get docs to build on Windows

[kalenkovich]

Reference issue

Fixes #8501

What does this implement/fix?

There are a few problems preventing docs from building on Windows. This PR is intended to fix them. As of now, it solves three out of four problems described in #8501.

[larsoner]

Actually it looks like the fourth problem can be solved here:

https://github.com/mne-tools/mne-python/blob/master/mne/viz/_brain/_scraper.py#L82

We probably do not need the leading / there.

And can you add a [circle front] to your next commit message to make CircleCI build the front-page examples? One of those has an animation and it would be good to make sure it still works. Alternatively, you can make some change to https://github.com/mne-tools/mne-python/blob/master/tutorials/source-modeling/plot_mne_dspm_source_localization.py. (CircleCI by default only builds changed examples, so you either need to change that one to get it to render, or add [circle front] to tell it to build all front-page ones.)

[larsoner]

Or it looks like you could also do:

export PATH=~/Miniconda3/Library/bin/graphviz:$PATH

or the equivalent for your system/env. Not sure if this is better, though.

[kalenkovich]

Yes, adding graphviz to path is a much saner solution than a separate install! I'll fix it.

I'll assume that graphviz has been installed into the conda environment and make use of the CONDA_PREFIX variable.

[kalenkovich]

fixed by 2bc392e

[larsoner]

@kalenkovich did you try the fix above for brain-scraped examples? You should be able to check by making the change then running:

PATTERN=mne_dspm make html_dev-pattern

It should only run the mne_dspm_solutions example in tutorials/source-modeling, then you can check the RST output.

It's best to be on the latest master version of sphinx-gallery because this one will ensure the example is run and RST file written even if the example was stale

[kalenkovich]

@kalenkovich did you try the fix above for brain-scraped examples? You should be able to check by making the change then running:

PATTERN=mne_dspm make html_dev-pattern

It should only run the mne_dspm_solutions example in tutorials/source-modeling, then you can check the RST output.

It's best to be on the latest master version of sphinx-gallery because this one will ensure the example is run and RST file written even if the example was stale

Not yet :(
Not sure I'll be able to get to it today, sorry about that.

I think removing the forward slash will make unix-based systems to treat the path as relative. So, it will work on Windows but break on other systems. Adding [circle front] will test it for us, right?

[larsoner]

I think removing the forward slash will make unix-based systems to treat the path as relative.

Only if the original path is relative. Based on what you see on Windows it might already be absolute. And [circle front] will indeed test things for us

[larsoner]

Okay I looked at the sphinx-gallery source code:

https://github.com/sphinx-gallery/sphinx-gallery/blob/master/sphinx_gallery/scrapers.py#L372-L374

Will push a fix that fixes things on Windows for me

[larsoner]

@kalenkovich feel free to add an entry to latest.inc, otherwise LGTM +1 for merge

[kalenkovich]

I added a line to latest.inc and fixed the code that adds graphviz to the path so that it actually works in git-bash.

Docs now build without errors on my pc. I'll mark this PR as ready for review then.

[larsoner]

Travis is unrelated, thanks @kalenkovich !

[agramfort]

thx @kalenkovich !