Sphinx Sqlalchemyiz extension
sphinxcontrib-sqlalchemyviz的Python项目详细描述
此文件提供了sphinx扩展名以包含实体关系 sqlalchemy元数据图，由 SQLAlchemyViz包。这是 一种高度未抛光的延伸部分，几乎不起重，也不起重 可跨平台移动。sqlalchemyviz包转换sqlalchemy 将元数据对象转换为点文件。然后扩展使用posix/linux工具 通过python的子进程机制来改进图形的布局。
为了直接从shell获得相同的效果，相关的命令将 比利时：
sqlaviz --unique-relations --show-constraints <pkg.module:metadata> -f out.dot ccomps -x out.dot | dot | gvpack -array3 | neato -Tpng -n2 -o out.png
注意
一些元数据模型使得sqlalchemyviz在graphviz/dot中遇到了一个错误。在 为了解决这个问题，已经切换了渲染命令 在v0.2到：
sqlaviz -p neato --unique-relations <pkg.module:metadata> -f out.dot ccomps -x out.dot | dot | gvpack -array3 | neato -Tpng -n2 -o out.png
一旦 潜在的错误已经解决。
注意
最近对sqlalchemyviz/pydot的更新在 生成.dot文件。这可以通过更改sqlaviz命令来解决 在v0.3到：
sqlaviz -p neato --unique-relations <pkg.module:metadata> -o node_margin='"0,0"' -f out.dot
安装和使用
此扩展可以从pypi安装：
pip install sphinxcontrib-sqlalchemyviz
在表应该出现的.rst文件中，插入sphinx 本模块提供的指令：
.. .. sqlaviz::
:metadataobject: full.importable.path.of.metadata有关基本用法示例，请参见：
| Python: | https://github.com/chintal/tendril/blob/master/tendril/utils/db.py#L201 |
|---|---|
| Generated: | http://tendril.chintal.in/doc/apidoc/tendril.utils.db/#tendril.utils.db.metadata |
许可证
此狮身人面像扩展根据BSD 2条款许可证提供。见 全文的许可证文件。
欢迎加入QQ群-->： 979659372
