-
Notifications
You must be signed in to change notification settings - Fork 100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC] - Update documentation #284
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! I left minor comments about rendering. Also, when running make html
, the build froze at plot_mne_example.py. If ^C'ed the process, it completed the build.
Thanks for the review @ryanhammonds! I fixed the stuff in the comments. In terms of the MNE example... hmmm, that seems to be building fine on my side, so I'm not sure what's up. There is a new minimum requirement for MNE after the updates in #259, but if that wasn't up to date I would expect that specific example to fail rather than having it hang. The MNE example is pretty slow - so I wonder if it just hadn't finished yet? Edit: to have a 1.1 candidate, I'm going to merge this in now - we can always revisit edits here and check back and any quirks with the MNE example build from there. |
Responds to #228 & #226
It adds a new "Visualizers" section to the docsite.
It adds a new "Motivations" piece exploring the notion of oscillations as peaks of power in the frequency domain (and some limitations in this).
It add new examples:
It also updates the Reference page, and adds an in code example of the reporting guidelines, which was added as a new section of the tutorial (I wasn't so clear where to put this, this seemed like a reasonable spot - but it could move).
Note that across these updates / new materials, these pieces are somewhat drafts that could be extended if people want to add more into them (eg - someone who knows more might want to add more notes to the knee related notes). The goal of this PR is to get the key pieces in, with good first versions, and then further updates can be made as needed as we move into 2.0.
Note: when this is ready and merged, it should also be merged to
name
(#205), with updates to move to specparam, so that these examples are also properly added to be 2.0 version.For ease of checking / reviewing - here is a copy of the built documentation including what's added:
html.zip
^If you download and unzip this, it's a copy of the built documentation page. Open the html folder, and double click 'index.html' to open the home page in a browser. Then you can click on the examples tab, and under the analyses section, click and see the new "Developmental Data Demo" example.