Skip to content
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

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

Open
coleslaw481 opened this issue Mar 7, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@coleslaw481
Copy link
Contributor

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

@coleslaw481 coleslaw481 added the enhancement New feature or request label Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant