交互式教育内容转换器。
innoconv的Python项目详细描述
innoconv
交互式教育内容转换器。
请参阅documentation了解安装和使用方法。
要求
对于tikz支持:
快速启动
# Install innoconv locally using pip $ pip install --user innoconv # Convert some content $ innoconv /path/to/content
码头工人
Docker image拥有所有
依赖项捆绑在一起,可以开箱即用。它允许您调用
innoconv
容器内的命令。
$ docker run innodoc/innoconv --help
要进行有用的转换,必须共享内容和输出文件夹
在主机和容器之间。还要确保设置用户id并使用
--force
标志。
$ docker run \ -v $(pwd)/innoconv_output:/output \ -v $(pwd)/tub_base:/content:ro \ -u `id -u $USER`\ innodoc/innoconv \ --force \ --output-dir /output \ /content
开发
毒性
InnoConv的开发依赖于tox。它 处理virtualenv创建、跨不同 python版本,也用于ci管道。
确保安装了它。
命令
有关命令的详细列表,请查看tox.ini
。
使用innoconv命令(开发版本)
在开发环境中生成外壳。
$ tox -e shell
或者直接启动当前的开发版本。
$ tox -e shell -- innoconv /path/to/content
起毛
遵守code style black和 PEP8。
$ tox -e linters
测试
运行单元和集成测试。
$ tox -e py37-unit,py37-integration
HTML覆盖率报告
覆盖率报告将在./htmlcov
中创建并通过http提供。
$ tox -e py37-unit,cov-html,serve-cov
文档
构建之后,您可以在docs/build/html
中找到文档并查看
它使用浏览器。
$ tox -e docs,serve-docs