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.

Sign up for GitHub

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

Jump to bottom

Add detailed documentation to methods in main classes #15

Open

shz9 opened this issue May 26, 2020 · 1 comment

Assignees

Collaborator

shz9 commented May 26, 2020

Add detailed documentation (ideally with examples) to methods in:

Genealogical
Pedigree
Traversal
Aligner

The text was updated successfully, but these errors were encountered:

ivan-krukov self-assigned this

Owner

ivan-krukov commented Jun 4, 2020

I added some sphinx-generated docs. Go to doc, and run make html to see them in full glory. The starting point is doc/build/html/index.html.

Should we consider some private hosting options? Or are folks okay with building this locally?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment