MRG: Devdocs

[sappelhoff]

Main point of this PR: Make CircleCI build devdocs. See point 3 in #369

accompanying PR: #371 ... #371 MUST BE MERGED BEFORE THIS ONE

binder

I said before that Binder will only work for the stable docs ... fortunately I was wrong!

With the addition in this PR (filepath_prefix) binder links are enabled for all versions:

• dev
• stable
• v0.3
• the versions prior to v0.3 did not have binder when they were released ... so they also don't have it now

circleCI key

I securely added a new CircleCI SSH key so that Circle can push the docs to our branch. Following this tutorial

WIKI

I updated the release post, and added a new post to document the changes I made:

• https://github.com/mne-tools/mne-bids/wiki/How-to-make-a-release
• https://github.com/mne-tools/mne-bids/wiki/Explanation-of-Documentation-Setup

Merge checklist

Maintainer, please confirm the following before merging:

• All comments resolved
• This is not your own PR
• All CIs are happy
• PR title starts with [MRG]
• whats_new.rst is updated
• PR description includes phrase "closes <#issue-number>"
• Commit history does not contain any merge commits

[codecov-io]

Codecov Report

Merging #370 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #370   +/-   ##
=======================================
  Coverage   95.16%   95.16%           
=======================================
  Files          11       11           
  Lines        1364     1364           
=======================================
  Hits         1298     1298           
  Misses         66       66

---

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 c916594...c0ac14f. Read the comment docs.

[sappelhoff]

MacOSX failure on Travis is unrelated (a timeout during download)

EDIT: I did a re-run and now it's green.

[jasmainak]

why this?

[sappelhoff]

that was an accidental change while moving from ~= syntax to >=X,<Y syntax ... reverted in 2277373 Thanks!

[jasmainak]

any chance of modifying this instead of deleting the whole thing? I like it be able to push the docs manually instead of just through CircleCI.

[sappelhoff]

Yes, it'd be possible ... but what I came up with seems quite ugly --> and there are still some assumptions that need to be fulfilled in order for this to work. I added comments. Any idea on how to improve this?

# assuming in mne_bids/doc directory ... otherwise, "make install" would not work
git checkout master

# assuming remote is configured as upstream
git pull upstream master

# make sure the local branch is aligned 
git reset --hard upstream/master

# Go back to top directory and use the main Makefile
cd ..
make build-doc

# Temporarily store HTML outputs
cp -r doc/_build/html ~/tmp_mne_bids_docs

# Get gh-pages branch and make sure it is up to date
# assuming that the gh-pages branch already exists locally
git checkout gh-pages
git pull upstream gh-pages
git reset --hard upstream/gh-pages

# remove current dev docs from gh-pages branch and replace with new ones
rm -rf dev/
cp -r ~/tmp_mne_bids_docs dev/
rm -rf ~/tmp_mne_bids_docs

# add and push
git add .
git commit -m "manual update of dev docs [skip ci]"
git push

[sappelhoff]

but maybe this can also be done in another PR, I am anxious to get this merged :-)

[jasmainak]

okay fair enough! mental sanity is important during work from home :)

[jasmainak]

also this link seems broken: https://mne.tools/mne-bids/dev/index.html

[sappelhoff]

also this link seems broken: https://mne.tools/mne-bids/dev/index.html

yes, it will only work once this is merged 😄

Edit: but preview it here: https://34-140864326-gh.circle-artifacts.com/0/html/index.html

[sappelhoff]

@jasmainak bump to merge :-)

we can automate details later (#370 (comment))

[jasmainak]

Done, thanks @sappelhoff !