Adding documentation for what is currently completed

[Mikerah]

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]

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]

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

[zixuanzh]

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

[jeamick]

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]

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!