lina-usc / pylossless

🧠 EEG Processing pipeline that annotates continuous data
https://pylossless.readthedocs.io/en/latest/
MIT License
24 stars 8 forks source link

ENH: Basic documentation for readthedocs #28

Closed scott-huberty closed 1 year ago

scott-huberty commented 1 year ago

Closes #27

Basic documentation build for read the docs... Containing installation, usage, API, contributing guide..

Note that the API ONLY concerned making the docstring compliant with Numpy format. The docstrings still need to be refactored for acccuracy and clarity in a follow up PR.

Once it is merged I can launch it on readthedocs so that it is viewable...

Screenshots:

Homepage Screen Shot 2023-02-10 at 2 40 59 PM

API Screen Shot 2023-02-10 at 2 35 19 PM

Implementation Screen Shot 2023-02-10 at 2 35 45 PM