Skip to main content

狮身人面像“astah”扩展;使用 astah 嵌入图表

项目描述

sphinxcontrib-astah

https://travis-ci.org/tk0miya/sphinxcontrib-astah.svg?branch=master https://coveralls.io/repos/tk0miya/sphinxcontrib-astah/badge.png?branch=master https://codeclimate.com/github/tk0miya/sphinxcontrib-astah/badges/gpa.svg

这个包包含 astah Sphinx 扩展。

此扩展使您能够通过astah嵌入图表。以下代码是示例:

.. image:: [filename]

.. astah-image:: [filename]

.. astah-figure:: [filename]

   caption of figure

环境

安装

$ pip install sphinxcontrib-astah

此扩展使用命令行中的 astah。您需要设置 astah 和 Java 包。

配置狮身人面像

将sphinxcontrib.astah添加到conf.py扩展中:

extensions += ['sphinxcontrib.astah']

并将您的 API 密钥设置为astah_command_path

astah_command_path = '/path/to/astah-command.sh'

指示

.. 图像:: [文件名] , .. 图:: [文件名]

有了这个扩展,imagefigure指令可以将 astah 图像嵌入到文档中。同时,指令通过:option:选项接受sheet参数。

例子:

.. image:: my-diagram.asta

.. figure:: my-diagram.asta

   caption

.. image:: my-diagram.asta
   :option: sheet=class-diagram

.. astah-image:: [文件名]

该指令将图表插入到文档中。如果您的图表有多个工作表,请在#之后指定 sheetid 。

例子:

.. astah-image:: my-diagram.asta

.. astah-image:: my-diagram.asta#class-diagram

选项与image 指令相同。

.. astah-figure:: [文件名]

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

例子:

.. astah-figure:: my-diagram.asta

   Structure of this system

选项与figure 指令相同。

配置选项

astah_command_path

astah-command.sh(或 astah-command.bat)的路径

下载文件

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

源分布

sphinxcontrib-astah-1.0.0.tar.gz (4.3 kB 查看哈希)

已上传 source

内置分布

sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl (6.0 kB 查看哈希

已上传 2 7