search

kitchensjn / tskit_arg_visualizer

Interactive visualization method for ancestral recombination graphs
MIT License
11 stars 3 forks source link

Link to docs? #97

Open hyanwong opened 3 days ago

hyanwong commented 3 days ago

It's not clear to me where I can view the tskit_arg_visualizer docs, that are currently stored in the /docs directory. Is there a location on PyPI? I was trying to remember the syntax for changing node symbols, and it was quite hard to hunt down. Perhaps you could put a link from the main README file to those docs, somehow?

kitchensjn commented 3 days ago

I'd say that documentation does not currently exist, though definitely needed. The files in /docs don't include many examples for how to interact with the package, more just an overview of how things are structured. I'd be up for starting a JupyterBook similar to the other tskit environment repos at least to include functionality that has been more stable.