Add API documentation (e.g., readthedocs.io)

[adarob]

[studioph]

I second this, I'm working on a ML project right now using NoteSequences, but having to manually inspect the source code is killing me

[deathrc]

Me too, looking forward to the official documentation.

[wtong98]

Any updates on this issue? Would love to contribute if help is needed!

[adarob]

I'm not sure any of us on the Google side will have time to do this any time soon, but if someone would like to take it on, please do!

[wtong98]

Sounds good, I threw together some super quick, autogenerated docs parsed from the docstrings. It's definitely not a long-term fix, but I hope some of you might find it useful until proper documentation is assembled.

For easy browsing, I've also uploaded the html files here: https://wlt.coffee/cream/docs/note_seq/

[kaosbeat]

William,

That is great having a look at the easy browsing version. also @Adam is this a sign not much is going on on the magenta side at google? Is there a road map for magenta?

Asking because I'm about to start a rather large effort that will be using it...

Kasper

On Thu, Jul 22, 2021 at 5:30 AM William Tong @.***> wrote:

Sounds good, I threw together some super quick, autogenerated docs parsed from the docstrings. It's definitely not a long-term fix, but I hope some of you might find it useful until proper documentation is assembled.

For easy browsing, I've also uploaded the html files here: https://wlt.coffee/cream/docs/note_seq/

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/magenta/note-seq/issues/15#issuecomment-884633998, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABR6VB2WR2NYD5DSCOAIVTTY6GDTANCNFSM4RNIABIQ .

[adarob]

There is plenty happening on Magenta at Google, but we're heads down in research right now and don't have much time to devote to improving the library documentation.