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

Add pdoc autogenerated docs #46

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add pdoc autogenerated docs #46

wants to merge 1 commit into from

Conversation

wtong98
Copy link

@wtong98 wtong98 commented Jul 22, 2021

Some quick-n-dirty documentation addressing #15

These doc files were generated automatically from existing docstrings using pdoc3. It does a pretty good job of parsing most things, and huge shoutout to the maintainers for keeping crisp, clean docstrings, but it cannot catch everything. In particular, I've omitted everything under note_seq/alignment. These files are not generated automatically, but if you'd like, we can discuss additional infrastructure to do so.

This is certainly not a long-term solution, but a quick fix so users don't have to go digging in source to read the docs. For convenience, I've also tossed the files here, where they can be browsed: https://wlt.coffee/cream/docs/note_seq/

Ideally, we would have a proper readthedocs site, but that would be a much longer, time-consuming project. In the meanwhile, I hope people find this useful!

@google-cla
Copy link

google-cla bot commented Jul 22, 2021

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@google-cla google-cla bot added the cla: no label Jul 22, 2021
@wtong98
Copy link
Author

wtong98 commented Jul 22, 2021

@googlebot I signed it!

@google-cla google-cla bot added cla: yes and removed cla: no labels Jul 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant