Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Hey I’m in the process of documenting a library for my startup, do you have any more thoughts about your process?


I would just say follow pyserial example if that is something you like; look at their source code docstrings vs the documentation including the API bits.

If that's something you like, then just lift their documentation/ wholesale and tailor it to your needs, which is how I started. I also tweaked the sphinx settings to generate a pdf as well, but that was a special thing for the customer we were delivering the library and documentation to.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: