idekerlab / cellmaps_utils

MIT License
1 stars 0 forks source link

Update documentation for `music_utils.py` to work with autodoc in sphinx #1

Open coleslaw481 opened 1 year ago

coleslaw481 commented 1 year ago

refactor the documentation for music_utils.py to match docstring expected by autodoc and sphinx. Currently the documentation is just showing as raw text as one line as seen in this screenshot (run make docs to see in browser):

Note how the documentation is more readable for cellmaps_utils.cellmaps_utilscmd module and just plain text under cellmaps_utils.music_utils module

Screen Shot 2023-03-07 at 2 44 31 PM