search

libp2p / py-libp2p

The Python implementation of the libp2p networking stack 🐍 [under development]
https://libp2p.io
Other
475 stars 106 forks source link

Adding documentation for what is currently completed #35

Open Mikerah opened 5 years ago

Mikerah commented 5 years ago

Hi,

It was nice meeting some of you at Devcon. It's great to see people our age (I'm a university student too!) do great things in the community.

This might be a tad bit early, but, it would be great to have documentation to get people trying to use py-libp2p in their projects and have a tutorial.

Python has several libraries that can do docs automatically. Do you guys have any thoughts on which ones to use?

zixuanzh commented 5 years ago

Hey Mikerah,

Great to meet you in person at Devcon as well. Yes, we are working on those and we have docstrings in all our code. We are planning to use pydoc to generate documentation from there.

jmcph4 commented 5 years ago

Any progress on this, or is this still up for grabs?

zixuanzh commented 5 years ago

@jmcph4 we have docstrings in most of our code, would love to have your contribution in auto-generated documentation 👍

jeamick commented 5 years ago

Hey guys,

Is there a structure you want to follow for the documentation file ? Like the one from the rust implementation : https://docs.rs/libp2p/0.7.0/libp2p/ @zixuanzh Thanks in advance for the answer, JM

zixuanzh commented 5 years ago

Hi @jeamick, welcome! We have docstrings in most of our code, it will be great if you can add documentation from these docstrings with auto-generators like sphinx or pydoc. Your help is greatly appreciated!