search

cytoscape / py2cytoscape

Python utilities for Cytoscape and Cytoscape.js
https://py2cytoscape.readthedocs.io
MIT License
178 stars 45 forks source link

readthedocs #48

Closed jorgeboucas closed 6 years ago

jorgeboucas commented 6 years ago
jorgeboucas commented 6 years ago

@bdemchak weebhook needed

jorgeboucas commented 6 years ago

py2cytoscape.readthedocs.io running

@bdemchak - need you user name in https://readthedocs.org to add you as a maintainer.

bdemchak commented 6 years ago

Hi, Jorge –

My not-so-secret alias is idekerlab.bdemchak@gmail.com mailto:idekerlab.bdemchak@gmail.com

Please sign me up …

Looking over the document, this looks like a good start, and I think it will be useful almost immediately.

The real gold, though, will be in the documentation of the library API. Is that where this is actually going?

From: Jorge Boucas [mailto:notifications@github.com] Sent: Saturday, February 10, 2018 3:27 AM To: cytoscape/py2cytoscape py2cytoscape@noreply.github.com Cc: Barry Demchak idekerlab.bdemchak@gmail.com; Mention mention@noreply.github.com Subject: Re: [cytoscape/py2cytoscape] readthedocs (#48)

py2cytoscape.readthedocs.io https://py2cytoscape.readthedocs.io running

@bdemchak https://github.com/bdemchak - need you user name in https://readthedocs.org to add you as a maintainer.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/cytoscape/py2cytoscape/issues/48#issuecomment-364645024 , or mute the thread https://github.com/notifications/unsubscribe-auth/ADhl3vMa70UPyqVoEstVoj5ritNfF5hrks5tTX0IgaJpZM4R4iLD . https://github.com/notifications/beacon/ADhl3moq1BLbcoMupvNFWQC1GCfmhMfXks5tTX0IgaJpZM4R4iLD.gif

jorgeboucas commented 6 years ago

done.

Yup, every function will have it's documentation in the docstring and in the readthedocs respective location. In readthedocs there will additionally be an example of input, call, and output.

I will start with the rest functions as I go along building them. Once that is over and we review the whole project I will move on to do the same for all other functions in the package.

For the future, the addition or modification of functions should only be allowed if the respective documentation in /docs has also been changed.

bdemchak commented 6 years ago

Nifty!

From: Jorge Boucas [mailto:notifications@github.com] Sent: Monday, February 12, 2018 9:19 AM To: cytoscape/py2cytoscape py2cytoscape@noreply.github.com Cc: Barry Demchak idekerlab.bdemchak@gmail.com; Mention mention@noreply.github.com Subject: Re: [cytoscape/py2cytoscape] readthedocs (#48)

done.

Yup, every function will have it's documentation in the docstring and in the readthedocs respective location. In readthedocs there will additionally be an example of input, call, and output.

I will start with the rest functions as I go along building them. Once that is over and we review the whole project I will move on to do the same for all other functions in the package.

For the future, the addition or modification of functions should only be allowed if the respective documentation in /docs has also been changed.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/cytoscape/py2cytoscape/issues/48#issuecomment-364995163 , or mute the thread https://github.com/notifications/unsubscribe-auth/ADhl3r-KQIab5p4_f4y1lqQpq7NejJ45ks5tUHKUgaJpZM4R4iLD . https://github.com/notifications/beacon/ADhl3gLLFn6fpYvUD0kucnmL2hKdEIUtks5tUHKUgaJpZM4R4iLD.gif