sphinxcontrib-astah 1.0.0

sphinxcontrib-astah

此包包含astah Sphinx扩展。

此扩展允许您通过astah 嵌入图表。以下代码是示例

.. image:: [filename]

.. astah-image:: [filename]

.. astah-figure:: [filename]

   caption of figure

设置

$ pip install sphinxcontrib-astah

extensions += ['sphinxcontrib.astah']

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

指令

.. image:: [filename], .. figure:: [filename]

使用此扩展，image 和 figure 指令可以将astah图像嵌入到文档中。同时，指令通过 :option: 选项接受 sheet 参数。

示例

.. image:: my-diagram.asta

.. figure:: my-diagram.asta

   caption

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

.. astah-image:: [filename]

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

示例

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

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

选项与 image 指令 相同。

.. astah-figure:: [filename]

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

示例

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

   Structure of this system

选项与 figure 指令 相同。

配置选项

astah_command_path

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