Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Sphinx "astah" extension; embed diagram by using astah

Project description


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



$ 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

extensions += ['sphinxcontrib.astah']

And set your API key to astah_command_path:

astah_command_path = '/path/to/'


.. 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.


.. image:: my-diagram.asta

.. figure:: my-diagram.asta


.. 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 #.


.. 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.


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

   Structure of this system

Options are same as figure directive .

Configuration Options


path to (or astah-command.bat)

Project details

Release history Release notifications

This version
History Node


History Node


History Node


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl (6.0 kB) Copy SHA256 hash SHA256 Wheel 2.7 Jun 26, 2015
sphinxcontrib-astah-1.0.0.tar.gz (4.3 kB) Copy SHA256 hash SHA256 Source None Jun 26, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page