Skip to main content

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 上传

下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

docuit-0.4.tar.gz (3.4 kB 查看哈希)

已上传 source