Python文档字符串即时转换为Markdown
项目描述
docstring-to-markdown
Python文档字符串即时转换为Markdown
- Python 3.6+ (在3.7到3.11上进行了测试)
- 可以识别reStructuredText并将其多个功能转换为Markdown
- 自v0.13起包含对Google格式文档字符串的初始支持
安装
pip install docstring-to-markdown
示例
转换reStructuredText
>>> import docstring_to_markdown
>>> docstring_to_markdown.convert(':math:`\\sum`')
'$\\sum$'
当给定的格式无法识别时，将引发异常
>>> docstring_to_markdown.convert('\\sum')
Traceback (most recent call last):
raise UnknownFormatError()
docstring_to_markdown.UnknownFormatError
开发
pip install -e .
pytest
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。
源分布
docstring-to-markdown-0.15.tar.gz (29.2 kB 查看哈希值)
构建版本
关闭
docstring-to-markdown-0.15.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | e146114d9c50c181b1d25505054a8d0f7a476837f0da2c19f07e06eaed52b73d |
|
| MD5 | fe2d4afd2e75807fc8b72957aaef8a29 |
|
| BLAKE2b-256 | 7aad6a66abd14676619bd56f6b924c96321a2e2d7d86558841d94a30023eec53 |
关闭
docstring_to_markdown-0.15-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 27afb3faedba81e34c33521c32bbd258d7fbb79eedf7d29bc4e81080e854aec0 |
|
| MD5 | 0e4c4f2f60fba46c0b1b136e9262d89e |
|
| BLAKE2b-256 | c1cf4eee59f6c4111b3e80cc32cf6bac483a90646f5c8693e84496c9855e8e38 |