nxviz icon indicating copy to clipboard operation
nxviz copied to clipboard

Docs not properly built

Open j-andrews7 opened this issue 6 years ago • 1 comments

Trying to determine how to use this package, but the docs appear to be missing, well, just about everything. The usage page gives a single blurb that's not too helpful, and I think the API docs aren't being built properly.

There aren't many options for Circos plots in python, plotly is the only other option I know of, but it's quite involved and rather limited in some ways. This looks like a good alternative, but reading the docstrings and trying to piece together use cases is proving difficult.

j-andrews7 avatar Jan 31 '19 16:01 j-andrews7

Oh wow - that's surprising for me. Thanks for the catch! I'm at work in the middle of a project hacking session right now, but I'll get to this soon.

Until then, the examples directory should point you to how to use the API. https://github.com/ericmjl/nxviz/tree/master/examples/circos

ericmjl avatar Jan 31 '19 20:01 ericmjl