Docuit 是一种工具,可确保您的 README 保持最新并简化从 README 中获取所需部分的过程。
项目描述
Docuit 是一种工具,可确保您的 README 保持最新并简化从 README 中获取所需部分的过程。
当使用多个存储库(可能是不同的语言)时,需要获取构建、测试、运行和部署的步骤以使用源代码。在良好的情况下,如果有适当的文档,有时一遍又一遍地找到它是很乏味的。
Docuit 解析所需部分的 README 并将它们打印出来,或者可以立即执行这些步骤。
docuit 检查以确保所有必要的部分都存在并打印出缺少的部分。
docuit build|test|run|deploy打印该部分的内容。
--exec标志将执行这些步骤。
使用 docuit 可确保所有存储库都具有类似的 README 结构,简化代码的使用,并且通过正确的设置还可以简化继续部署过程:docuit deploy --exec。
建造
pip install -r requirements.txt
测试
薄片8 *.py
跑
文档
部署
python setup.py sdist 上传