转换包docstring并使其符合新样式
docconvert的Python项目详细描述
Docconvert公司
更新或转换现有Python文件中的docstring。在
这个Python（2.7+/3.6+）模块和脚本旨在帮助Python程序员 使用docstring增强内部代码文档。 协调或更改项目docstring样式格式非常有用。在
它将解析一个或多个python脚本并检索现有的docstring。 然后，对于所有找到的模块/函数/方法/类，它将转换docstring 参数、返回值和其他字段的格式为新指定的样式。在
目前，输入/输出中的托管样式有：
输入
输出
入门
安装
Docconvert可以通过pip安装：
pip install docconvert
用法
^{pr2}$示例：
使用4个线程将src/mypackage中的文件转换为google。在
docconvert --output google --threads 4 src/mypackage/
将文件src/mypackage/myfile.py从rest转换到google。在
docconvert --input rest --output google src/mypackage/myfile.py
自定义配置
您可以在json配置文件中配置可选的转换参数。只是 指定命令行工具的配置文件路径。在
docconvert --config path/to/config.json src/mypackage/
有关所有配置选项的详细说明，请参阅 documentation。在
贡献
如果你想贡献，请看看 contributor documentation。在
版本控制
我们使用SemVer进行版本控制。 有关可用版本，请参阅存储库上的标记。在
许可证
本项目根据BSD-3条款许可证获得许可。 见许可证.md详细信息请存档。在
- 项目
标签：
欢迎加入QQ群-->： 979659372
