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

Is there documentation for bx-python outside the codebase? #16

Closed
alexlenail opened this issue Feb 1, 2017 · 9 comments
Closed

Is there documentation for bx-python outside the codebase? #16

alexlenail opened this issue Feb 1, 2017 · 9 comments

Comments

@alexlenail
Copy link

alexlenail commented Feb 1, 2017

the wiki page redirects to the repo main page which is weird...

@dylanmmarshall
Copy link

I too, would like it if there was further documentation...

@dylanmmarshall
Copy link

I noticed there was an initial attempt at sphinx documentation https://github.com/bxlab/bx-python/tree/master/doc/source/static but wasn't followed up on.

@alexlenail
Copy link
Author

@DylanM-Marshall if you're in the genomics space, fastinterval depends on this and has better docs. http://fastinterval.readthedocs.io/en/latest/

@dylanmmarshall
Copy link

That's awesome and all, but my files are primarily bigwig, not fasta - even if conversion between the two is relatively simple.

@jxtx
Copy link
Contributor

jxtx commented Feb 22, 2017 via email

@dylanmmarshall
Copy link

@jxtx That would be super cool

@jxtx
Copy link
Contributor

jxtx commented Feb 23, 2017

http://bx-python.readthedocs.io/en/latest/

(it's a start)

@dylanmmarshall
Copy link

Great things have small beginnings!

@jxtx
Copy link
Contributor

jxtx commented Feb 23, 2017

Okay, now we are getting somewhere. Docs should be building for all modules including Cython ones. Now just need to fill in some of those doc strings.

http://bx-python.readthedocs.io/en/latest/lib/bx.bbi.bigwig_file.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants