如何写python程序文档

https://sklearn.apachecn.org/docs/0.21.3/
上面这个网址是个很好的参考写程序的文档。

写文档的七个技巧如下：
1，专注于想法，然后审查和塑造你的文本
第一步不需要考虑文本的风格和组织，专注于编写文档的内容。第二步就是对整个文本进行修正，以便能够简单理解。修正文本意味着要增强其风格，纠正其错误，重新组织它，并删除任何冗余的内容。
2，准确定位读者
编写开发文档时，首先应该考虑谁会读这个文档？因此，好的开发文档应该遵循一个简单的规划，即每个文本应该只针对一种类型的读者。而这也使编写文档更容易，因为我们可以准确地知道面对的是什么样的读者。
3，读者喜欢简短的句子，每个句子最好不要超过两行，每一段只表达一个思想 ，最好少于四哥句子。每个想法的解释不要重复太多，避免像新闻那样重复，能够读懂就行。
4， 撰写贴合内容的标题。建议大家在编写开发文档时，将段落聚集在给定章节的有意义的标题下；整个文档的标题可以用短语来组织；文档的目录可以由所有章节的标题组成。
5，文档中应使用项目中的代码作为实例。
6，文档内容以实用为主。其实，软件开发中所用的大部分方法，是不需要用文档进行说明的，相比更详尽的文档，使软件正常工作无疑更重要。因此，一个好的做法是只编写真正需要的文档，而不是编写一个详尽的文档集。
7，使用模板。以维基百科为例，你会发现它每个页面的布局都是相似的，一侧有用于总结日期或事实的文本框，文档开头总有一个目录（包含该页面中的所有标题的链接），文档结尾处总有一个参考部分，等等。