项目描述
安装
$ [sudo] pip install readme-md
功能
<section-name>.md 部分- attrs/properties/methods 部分 - 子类
readme_md.Readme
- 自动标题 - 如果第1行不为空且不是
# 标题
- 部分 顺序 -
Readme.order 或 order.txt
- python项目（需要
setup.cfg）部分 - install、classes、functions、cli
类
readme_md.Readme - README.md生成器
Readme 属性 |
__doc__ |
header_lvl |
标题默认级别（4） |
标题 |
包含部分标题的字典（可选） |
order |
部分顺序列表 |
部分 |
包含部分的字典（从.md文件加载） |
Readme 方法 |
__doc__ |
get_header(name) |
返回部分标题的字符串 |
get_section(name) |
返回README部分的字符串 |
get_sections() |
返回按 order 排序的包含所有部分的（名称，字符串）对的列表 |
load(path) |
加载部分和顺序 |
渲染函数 |
将渲染内容转换为字符串 |
保存(path='README.md') |
保存到文件 |
函数
| 函数 |
__doc__ |
readme_md.broken_links(string, timeout=5) |
返回包含损坏的Markdown链接的列表 |
readme_md.links(string) |
返回包含Markdown链接的列表 |
readme_md.tables.attrs(cls) |
返回包含类属性表的字符串 |
readme_md.tables.cls(cls) |
返回包含类名、描述和属性+方法+属性表的字符串 |
readme_md.tables.methods(cls) |
返回包含类方法表的字符串 |
readme_md.tables.properties(cls) |
返回包含类属性表的字符串 |
readme_md.tables.usage(modules) |
返回包含CLI模块使用表的字符串。 python -m module 或模块 USAGE 变量（如果已定义）。 if __name__ == "__main__" 行必需 |
命令行界面
| 用法 |
__doc__ |
python -m readme_md.broken_links 路径 [超时时间] |
打印README.md中的损坏链接 |
python -m readme_md.create [路径 ...] |
生成README.md |
python -m readme_md.links 路径 |
打印README.md中的链接 |
示例
# .README/examples.md, .README/features.md, .README/order.txt
$ python -m readme_md.create .README > README.md
$ python -m readme_md.broken_links README.md # find broken links
class Readme_npm(readme_md.Readme):
order = ["description","features","install", ...]
disabled = ["generator"]
@property
def install(self):
return "`$ [sudo] npm i -g %s`" % json.loads(path)["name"]
Readme(".README").save("README.md") # load sections and create README.md
readme-md - README.md生成器
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
源分布
构建分布
