python项目的readme.md生成器
python-readme-generator的Python项目详细描述
安装
$ [sudo] pip install python-readme-generator
功能
- 基于readme-generator
<section-name>.md
,attrs/methods/props作为节- 自动标题
- python部分:
install
,classes
,functions
。setup.cfg
默认为必需
类
- 基于readme-generator
<section-name>.md
,attrs/methods/props作为节- 自动标题
- python部分:
install
,classes
,functions
。setup.cfg
默认为必需
类
class | ^{ |
---|---|
^{ | methods: ^{ |
可执行模块
usage | ^{ |
---|---|
^{ | generate README.md |
创建自定义自述类
importpython_readme_generatorclassReadme(python_readme_generator.Readme):headers={"badges":""}locations=python_readme_generator.Readme.locations+[".config/README"]order=['badges','install','features','classes','functions','next',...]defbadges(self):...Readme().save("README.md")