一种快速而简单的方法来制作漂亮的文档标记文件。
docstr-md的Python项目详细描述
Docstring Markdown是一种快速而简单的方法来制作漂亮的文档降价文件。在
为什么是Docstring降价
是时候和全世界分享你的新套餐了。还有。。。准备好下周做你的文件。或者，只需几行代码就可以用Docstring标记创建漂亮的文档。在
安装
$ pip install docstr-md
快速启动
首先，从Docstring Markdown repo克隆一个测试文件。在
^{pr2}$示例test.py使用sklearn格式的docstring。让我们把它转换成降价。在
fromdocstr_md.pythonimportPySoup,compile_mdfromdocstr_md.src_hrefimportGithubsrc_href=Github('https://github.com/dsbowen/docstr-md/blob/master')soup=PySoup(path='test.py',parser='sklearn',src_href=src_href)compile_md(soup,compiler='sklearn',outfile='test.md')
现在您的当前目录中有一个test.md文件。This是它呈现的样子。在
引文
@software{bowen2020docstr-md,
author = {Dillon Bowen},
title = {Docstring-Markdown},
url = {https://dsbowen.github.io/docstr-md/},
date = {2020-05-15},
}
许可证
用户必须在使用此软件的任何出版物中引用Docstring Markdown。在
Docstring Markdown是由MITLicense授权的。在
- 项目
标签：
欢迎加入QQ群-->： 979659372
