跳转到主要内容

Sphinx "cacoo" 扩展;在文档中嵌入 cacoo 图表

项目描述

sphinxcontrib-cacoo

此Sphinx扩展允许您将cacoo中的图表嵌入到您的文档中

.. image:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL

.. figure:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL

   caption of figure

设置

安装

$ pip install sphinxcontrib-cacoo

配置Sphinx

conf.py 中将 sphinxcontrib.cacoo 添加到 extensions

extensions += ['sphinxcontrib.cacoo']

并将您的API密钥设置为 cacoo_apikey

cacoo_apikey = 'your apikey'

用法

请将 caoo 图表的URL作为参数传递给 imagefigure 指令

.. image:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL

.. figure:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL

   caption of figure

指令

为了与向后兼容性,此扩展提供以下两个指令。

.. cacoo-image:: [URL]

此指令将图表插入到文档中。如果您的图表有多个页面,请在 # 后指定 sheetid。

示例

.. cacoo-image:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL

.. cacoo-image:: https://cacoo.com/diagrams/mb53vvmYG38QGUPf#37D74

选项与 image 指令 相同。

.. cacoo-figure:: [URL]

此指令将图表及其标题插入到文档中。

示例

.. cacoo-figure:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL

   Structure of this system

选项与 figure 指令 相同。

配置选项

cacoo_apikey

cacoo 的API密钥

仓库

https://github.com/tk0miya/sphinxcontrib-cacoo

项目详情


下载文件

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

源代码分布

sphinxcontrib-cacoo-2.0.0.tar.gz (4.3 kB 查看哈希值)

上传时间 源代码

构建版本

sphinxcontrib_cacoo-2.0.0-py2.py3-none-any.whl (3.9 kB 查看哈希值)

上传时间 Python 2 Python 3

由以下组织支持