doc2md 0.1.0

许可证

版权©2013 Thomas Gläßle t_glaessle@gmx.de

此作品是免费的。您可以在Sam Hocevar发布的Do What The Fuck You Want To Public License，版本2的条款下重新分发或修改它。有关更多详情，请参阅COPYING文件。

此程序是免费软件。在适用法律允许的范围内，它不附带任何保证。

描述

一个小巧方便的工具，可以从模块或类中提取docstring并将它们转换为GitHub Flavoured Markdown

https://help.github.com/articles/github-flavored-markdown

它的目的是为小型项目快速生成README.md文件。

API

界面由以下函数组成

• doctrim(docstring)

• doc2md(docstring, title)

您可以从命令行运行此脚本，如下所示

$ doc2md.py [-a] [--no-toc] [-t title] module-name [class-name] > README.md

限制

目前这仅适用于非常特定的用例。很难预见我是否会在不久的将来决定改进它。