Skip to main content

Sphinx "astah" extension; embed diagram by using astah

Project description

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

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)

Project details


Download files

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

Files for sphinxcontrib-astah, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl (6.0 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size sphinxcontrib-astah-1.0.0.tar.gz (4.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page