python中的raml文档生成器
griffin的Python项目详细描述
要求和安装
用户设置
最新版本(当前仅限alpha)可以在PyPI上找到,您可以通过pip:
$ pip install griffin --pre
需要下载--pre,因为它仍在alpha中。
继续usage开始使用griffin。
支持的python/系统
警告
当前使用Python2.7运行,但将获得3.3+和PyPy
警告
当前使用Python2.7运行,但将获得3.3+和PyPy
Linux和OS X都受支持。
开发者设置
如果你想在griffin上贡献或发展,请务必阅读How to Contribute 第一。
系统要求:
- C编译器(gcc/clang/etc.)
- 如果在linux上,您需要安装python头文件(例如apt-get install python-dev)
- python 2.6、2.7、3.3+或pypy
- virtualenv
以下是如何设置您的机器:
$ git clone git@github.com:spotify/griffin $ cd griffin $ virtualenv env $ source env/bin/activate (env) $ pip install -r dev-requirements.txt
运行测试
如果要对所有受支持的python版本运行测试,则必须具有所有python版本 安装在您的系统上。我建议pyenv来帮忙。
运行所有测试:
(env) $ tox
运行特定的测试设置(选项包括:py26,py27,py33,py34,pypy, ^{TT10}$,^{TT11}$,^{TT12}$,^{TT13}$,^{TT14}$,^{TT15}$):
(env) $ tox -e py26
运行不含毒素的测试:
(env) $ py.test (env) $ py.test --cov griffin --cov-report term-missing
生成文档
文档是用Sphinx构建的,用rst编写,使用Read the Docs主题 一个稍微定制的css,托管在Read the Docs site。
要在本地重建文档,请在父目录griffin中:
(env) $ tox -e docs
或:
(env) $ sphinx-build -b docs/ docs/_build
或:
(env) $ cd docs (env) $ make html
然后在griffin/docs/_build中,您可以在浏览器中打开index.html页面。
更改日志
0.0.1a(2015-07-29)
超级阿尔法版本!