reStructuredText

reStructuredText 是一种易于阅读的、看到的就是得到的纯文本标记语法和解析器系统。它对于内联程序文档(如Python文档字符串)、快速创建简单web页面和独立文档非常有用。reStructuredText设计用于特定应用程序领域的可扩展性。reStructuredText解析器是Docutils的一个组件。reStructuredText是对StructuredText和Setext轻量级标记系统的修改和重新解释。

reStructuredText的主要目标是定义并实现用于Python文档字符串和其他文档领域的标记语法，该语法可读且简单，但功能强大，足以用于重要用途。标记的预期目的是将reStructuredText文档转换为有用的结构化数据格式。

看到 statemachine.py对于使用reStructuredText完全文档化的Python模块示例。