有关功能或文档的信息放在功能的文档字符串中。以下是编写文档字符串时要遵循的准则。
第一行应始终是对象用途的简短摘要。为简便起见，它不应明确声明对象的名称或类型。该行应以大写字母开头，以句点结尾。
如果文档字符串中还有更多行，则第二行应为空白，以可视方式将摘要与描述的其余部分分开
狮身人面像
Sphinx是最受欢迎的Python文档工具。它将reStructuredText标记语言转换成多种输出格式，包括HTML，LaTeX（用于可打印PDF版本），手册页和纯文本。
运行时，Sphinx将导入您的代码，并使用Python的自省功能提取所有函数，方法和类签名。它还将提取随附的文档字符串，并将其全部编译为项目的结构良好且易于阅读的文档。