This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Sphinx "astah" extension; embed diagram by using astah

Project Description

sphinxcontrib-astah

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)
Release History

Release History

This version
History Node

1.0.0

History Node

0.2.0

History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl (6.0 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Jun 26, 2015
sphinxcontrib-astah-1.0.0.tar.gz (4.3 kB) Copy SHA256 Checksum SHA256 Source Jun 26, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting