-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #124 from CBroz1/main
Cleanup docstrings, add notebook render
- Loading branch information
Showing
31 changed files
with
671 additions
and
392 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -102,6 +102,7 @@ ENV/ | |
|
||
# mkdocs documentation | ||
docs/site | ||
docs/src/tutorials/*ipynb | ||
|
||
# mypy | ||
.mypy_cache/ | ||
|
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Markdown Linter configuration for docs | ||
# https://github.com/DavidAnson/markdownlint | ||
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md | ||
MD009: false # permit trailing spaces | ||
MD007: false # List indenting - permit 4 spaces | ||
MD013: | ||
line_length: "88" # Line length limits | ||
tables: false # disable for tables | ||
headings: false # disable for headings | ||
MD030: false # Number of spaces after a list | ||
MD033: # HTML elements allowed | ||
allowed_elements: | ||
- "br" | ||
MD034: false # Permit bare URLs | ||
MD031: false # Spacing w/code blocks. Conflicts with `??? Note` and code tab styling | ||
MD046: false # Spacing w/code blocks. Conflicts with `??? Note` and code tab styling |
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,3 @@ | ||
|
||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# Contribution Guidelines | ||
|
||
This project follows the [DataJoint Contribution Guidelines](https://datajoint.com/docs/community/contribute/). Please reference the link for more full details. | ||
This project follows the | ||
[DataJoint Contribution Guidelines](https://datajoint.com/docs/community/contribute/). | ||
Please reference the link for more full details. |
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,156 @@ | ||
// cSpell Settings | ||
//https://github.com/streetsidesoftware/vscode-spell-checker | ||
{ | ||
"version": "0.2", // Version of the setting file. Always 0.2 | ||
"language": "en", // language - current active spelling language | ||
"enabledLanguageIds": [ | ||
"markdown", "yaml", "python" | ||
], | ||
// flagWords - list of words to be always considered incorrect | ||
// This is useful for offensive words and common spelling errors. | ||
// For example "hte" should be "the" | ||
"flagWords": [], | ||
"allowCompoundWords": true, | ||
"ignorePaths": [ | ||
"./element_array_ephys.egg-info/*", | ||
"./images/*" | ||
], | ||
"words": [ | ||
"acorr", | ||
"aggr", | ||
"Alessio", | ||
"Andreas", | ||
"apmeta", | ||
"arange", | ||
"asarray", | ||
"astype", | ||
"autocorrelogram", | ||
"Axona", | ||
"bbins", | ||
"bdist", | ||
"Binarize", | ||
"Brody", | ||
"Buccino", | ||
"catgt", | ||
"cbar", | ||
"cbin", | ||
"cdat", | ||
"Chans", | ||
"chans", | ||
"chns", | ||
"Clust", | ||
"clusterings", | ||
"cmap", | ||
"correlogram", | ||
"correlograms", | ||
"curations", | ||
"DANDI", | ||
"decomp", | ||
"DISTRO", | ||
"djbase", | ||
"dtype", | ||
"ecephys", | ||
"electrophysiogical", | ||
"elif", | ||
"Ephys", | ||
"gblcar", | ||
"gfix", | ||
"hdmf", | ||
"HHMI", | ||
"hstack", | ||
"ibllib", | ||
"ifnull", | ||
"Imax", | ||
"IMAX", | ||
"imax", | ||
"imec", | ||
"imread", | ||
"imro", | ||
"imrotbl", | ||
"imshow", | ||
"inlinehilite", | ||
"ipynb", | ||
"ipywidgets", | ||
"kcoords", | ||
"Klusta", | ||
"Kwik", | ||
"lfmeta", | ||
"linenums", | ||
"mdict", | ||
"Mesoscale", | ||
"mkdocs", | ||
"mkdocstrings", | ||
"Moser", | ||
"mtscomp", | ||
"Nchan", | ||
"nchan", | ||
"ndarray", | ||
"ndim", | ||
"ndimage", | ||
"Neuralynx", | ||
"NEURO", | ||
"neuroconv", | ||
"Neurodata", | ||
"Neuropix", | ||
"neuropixel", | ||
"NeuroPixels", | ||
"nwbfile", | ||
"NWBHDF", | ||
"oebin", | ||
"openephys", | ||
"openephys", | ||
"openpyxl", | ||
"phylog", | ||
"plotly", | ||
"PSTH", | ||
"pykilosort", | ||
"pymdownx", | ||
"pynwb", | ||
"pyopenephys", | ||
"pyplot", | ||
"pytest", | ||
"Reimer", | ||
"repolarization", | ||
"Roboto", | ||
"RRID", | ||
"Rxiv", | ||
"Sasaki", | ||
"scipy", | ||
"sdist", | ||
"Siegle", | ||
"sess", | ||
"SGLX", | ||
"Shen", | ||
"Sitonic", | ||
"spikeglx", | ||
"spkcount", | ||
"Stereotaxic", | ||
"tcat", | ||
"tickvals", | ||
"tofile", | ||
"Tolias", | ||
"tqdm", | ||
"vline", | ||
"Vmax", | ||
"vmax", | ||
"xanchor", | ||
"xaxes", | ||
"xaxis", | ||
"xcoords", | ||
"xcorr", | ||
"xlabel", | ||
"xlim", | ||
"XPOS", | ||
"xtick", | ||
"Yatsenko", | ||
"yaxes", | ||
"yaxis", | ||
"ycoord", | ||
"ycoords", | ||
"ylabel", | ||
"ylim", | ||
"YPOS", | ||
"yref", | ||
"yticks" | ||
] | ||
} |
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.