TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

How do you document your python code?

8 pointsby samrohn778almost 7 years ago
What are the best practices? Do you use Sphinx. If so how does your deployment look like? Is it worth the effort for a small startup to spend time and effort on it?

2 comments

mpetyxalmost 7 years ago
It totally depends on what you want to succeed. In our case, for example, we break our python code into microservices so it is more important documenting the APIs rather the code itself. If you are building complicated libraries, yes sphinx is the choice to go. Most important of all is to understand your deployments and your code lifecycle.
评论 #17417468 未加载
xstartupalmost 7 years ago
Our python projects have &lt;50 files. Each file with &lt;100LOC.<p>There are hardly any comments on the projects. So, far we&#x27;ve not faced any issue.