sphinxcontrib-astah

https://codeclimate.com/github/tk0miya/sphinxcontrib-astah/badges/gpa.svg

This package contains the astah Sphinx extension.

This extension enable you to embed diagrams by astah . Following code is sample:

.. image:: [filename]

.. astah-image:: [filename]

.. astah-figure:: [filename]

   caption of figure

Setting

Install

$ pip install sphinxcontrib-astah

This extension uses astah from commandline. You need to setup astah and Java package.

Configure Sphinx

Add sphinxcontrib.astah to extensions at conf.py:

extensions += ['sphinxcontrib.astah']

And set your API key to astah_command_path:

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

Directive

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

With this extension, image and figure directives can embed astah image to documents. At the same time, the directives accept sheet parameter through :option: option.

Examples:
.. image:: my-diagram.asta

.. figure:: my-diagram.asta

   caption

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

.. astah-image:: [filename]

This directive insert a diagram into the document. If your diagram has multiple sheets, specify sheetid after #.

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

.. astah-image:: my-diagram.asta#class-diagram
Options are same as image directive .

.. astah-figure:: [filename]

This directive insert a diagram and its caption into the document.

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

   Structure of this system
Options are same as figure directive .

Configuration Options

astah_command_path

path to astah-command.sh (or astah-command.bat)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-astah-1.0.0.tar.gz (4.3 kB view details)

Uploaded Jun 26, 2015 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl (6.0 kB view details)

Uploaded Jun 26, 2015 Python 2Python 3

File details

Details for the file sphinxcontrib-astah-1.0.0.tar.gz.

File metadata

Download URL: sphinxcontrib-astah-1.0.0.tar.gz
Upload date: Jun 26, 2015
Size: 4.3 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for sphinxcontrib-astah-1.0.0.tar.gz
Algorithm	Hash digest
SHA256	`beadc20daa10d3a0553fbde29a854a1e943435b15012b18740d71cd466e676a4`
MD5	`5df098974155ae7fddf11b6b8d1051ca`
BLAKE2b-256	`ee632bd48b01ffde744593f1a08f4ceb76d09bc29c49481748ea181b98dbf3fe`

See more details on using hashes here.

File details

Details for the file sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl.

File metadata

Download URL: sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl
Upload date: Jun 26, 2015
Size: 6.0 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No

File hashes

Hashes for sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`a6a023c0d881b5e567d0ef0b48e632a333401553a864e7644685dc91931fd6dc`
MD5	`497434a9297b0da8104cfb1966fd0cc1`
BLAKE2b-256	`d31ca66dbd492ec653f0e1d5950acced60958853bc02e9642c713ef46d693957`