MRG: Improve decoding doc and sphinx process #5707
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #5707 +/- ##
==========================================
- Coverage 88.61% 88.61% -0.01%
==========================================
Files 369 369
Lines 69463 69462 -1
Branches 11678 11678
==========================================
- Hits 61557 61556 -1
Misses 5055 5055
Partials 2851 2851 |
Contributor
|
I build it locally with But circle passes without issue. |
Member
Author
|
I don't see it locally either, maybe you need a newer numpydoc or sphinx |
Contributor
|
Actually, I mess up. It was my fault. |
Contributor
|
But I'm trying to compile it now, and it fails with this packages sphinx 1.7.6 py36_0 It does not like the keep going. So we need |
Contributor
|
This is my log: |
Member
Author
|
|
Contributor
|
yes! my bad. I had a messy tree. |
Member
Author
|
Yes the |
massich
approved these changes
Nov 13, 2018
2 tasks
Member
|
The tutorial looks great! |
agramfort
reviewed
Nov 13, 2018
agramfort
reviewed
Nov 13, 2018
agramfort
reviewed
Nov 13, 2018
agramfort
reviewed
Nov 13, 2018
agramfort
reviewed
Nov 13, 2018
agramfort
reviewed
Nov 13, 2018
Member
|
ok then
|
Member
Author
Yes, so I've moved the warning to the |
Member
Author
|
Forthcoming commit will also improve things by turning warnings during example runs into errors, so that our examples in doc building should (become, with these changes, and from here on out) stay clean |
mmagnuski
reviewed
Nov 13, 2018
mmagnuski
reviewed
Nov 13, 2018
Member
Author
|
Okay CIs are finally green and I think I've addressed all comments. Okay to merge @agramfort ? |
Member
Author
|
I'll actually go ahead and merge and we can tweak docs further if we need to for release (hopefully in the next couple of days!) |
agramfort
reviewed
Nov 14, 2018
|
|
||
| # Now we create a mixed src space by adding the volume regions specified in the | ||
| # list labels_vol. First, read the aseg file and the source space bounds | ||
| # using the inner skull surface (here using 10mm spacing to save time): |
Member
There was a problem hiding this comment.
sorry to be a bit later here but I am afraid people with just copy paste these defaults which are here due to running time. Can you make more explicit that oct5 and pos=10 are not recommended for real analysis? thx
Contributor
|
-- edit --- wrong PR. |
Member
Author
|
edit: (moved) |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR:
manual/decoding.rstinto a tutorial by folding it andexamples/decoding/plot_decoding_csp_space.pyintotutorials/plot_sensors_decoding.py@deprecateddecorator to properly set the number of spaces to avoid a build warningconf.pyto turn warnings into errors during example runs (we should not have un-caught warnings in examples)