使用CI生成ER图并将其放入readthedocs
使用CI生成ER图并将其放入readthedocs
提问于 2020-05-15 06:21:16
我有一个开源的API服务器项目，我正在尝试将它集成到连续的集成中。该项目使用SQL，我使用ELAlchemy手动生成一个png数据库关系图( png格式)，并将其放入我的文档中( .rst格式并上传到读取文档中)。
现在我正在使用Travis CI，我想知道是否可以从我的Travis CI构建结果中复制png文件，并将其放入读取文档中，这样我就不再需要手动生成ER图了。
回答 1
Software Engineering用户
发布于 2020-05-15 08:20:03
生成文档作为构建管道的一部分绝对是一个值得考虑的想法。
从概念上讲，您可以这样做：
- 使用常规的ERAlchemy在Travis上安装
pip install eralchemy - 在构建过程中生成图表
- 将呈现的图表上载到公共可用的URL (
rsync到文件服务器，上传到AWS S3，无论您喜欢什么) - 在.rst文档中，使用上传文件的URL将ER图嵌入为图像
这样，文档将始终显示图表的最新版本。请注意，这可能会有其自身的缺点。如果在不更新可能引用该图表的文档的情况下自动更新图表，则可能会使读者感到困惑。
页面原文内容由Software Engineering提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://softwareengineering.stackexchange.com/questions/410162
复制相关文章
相似问题
腾讯云开发者
