[DOC] Adding doc folder and tightening makefile recipes for checking style #22
Conversation
|
FYI: @mscheltienne |
Codecov Report
@@ Coverage Diff @@
## main #22 +/- ##
=======================================
Coverage 97.09% 97.09%
=======================================
Files 4 4
Lines 379 379
=======================================
Hits 368 368
Misses 11 11
Continue to review full report at Codecov.
|
|
Gonna merge to make the dev process easier w/ the Makefile recipes. |
| * ``mne`` (>=1.0) | ||
| * ``numpy`` (>=1.14) | ||
| * ``scipy`` (>=1.5.0) | ||
| * ``joblib`` (>=1.0.0) | ||
| * ``scikit-learn`` (>=1.1) | ||
| * ``torch`` (for running pytorch neural networks) | ||
| * ``python-picard`` (for running ICA) | ||
| * ``matplotlib`` (optional, for using the interactive data inspector) |
There was a problem hiding this comment.
Minor detail for now, but this should be updated when #16 is resolved. I'm guessing matplotlib and joblib are not required?
| % Encoding: UTF-8 | ||
| @article{AvantsEtAl2008, | ||
| author = {Avants, Brian B. and Epstein, Charles L. and Grossman, Murray C. and Gee, James C.}, | ||
| doi = {10.1016/j.media.2007.06.004}, | ||
| journal = {Medical Image Analysis}, | ||
| number = {1}, | ||
| pages = {26-41}, | ||
| shorttitle = {Symmetric Diffeomorphic Image Registration with Cross-Correlation}, | ||
| title = {Symmetric Diffeomorphic Image Registration with Cross-Correlation: Evaluating Automated Labeling of Elderly and Neurodegenerative Brain}, | ||
| volume = {12}, | ||
| year = {2008} | ||
| } | ||
|
|
||
| @book{OppenheimEtAl1999, | ||
| address = {Upper Saddle River, NJ}, | ||
| edition = {2 edition}, | ||
| title = {Discrete-{Time} {Signal} {Processing}}, | ||
| isbn = {978-0-13-754920-7}, | ||
| publisher = {Prentice Hall}, | ||
| author = {Oppenheim, Alan V. and Schafer, Ronald W. and Buck, John R.}, | ||
| year = {1999} | ||
| } |
There was a problem hiding this comment.
Oh yeah good catch, I need to replace this with the ICLabel publication and add to the docstring in #21 for label_ic and the ICLabelNet.
|
|
||
| This is the application programming interface (API) reference | ||
| for classes (``CamelCase`` names) and functions | ||
| (``underscore_case`` names) of MNE-Connectivity, grouped thematically by analysis |
There was a problem hiding this comment.
One MNE-Connectivity reference that slipped by ;)
| @@ -0,0 +1,24 @@ | |||
| [tool.black] | |||
| line-length = 100 | |||
There was a problem hiding this comment.
I think it says 115 in .flake8. Normal?
There was a problem hiding this comment.
Not sure tbh. It might be needed to not error out, but I'll do some tests.
PR Description
Addresses #20 and setting up docs folder.
We need to migrate to MNE to setup circleci for docs building, so it'll take a few iterations to make sure we got everything right w/o errors.
Merge checklist
Maintainer, please confirm the following before merging: