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:
.. 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
.. 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-diagramOptions 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 systemOptions are same as figure directive .
Configuration Options
astah_command_path
path to astah-command.sh (or astah-command.bat)
Repository
This code is hosted by Bitbucket.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-astah-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70084516f658979be8d158df821486d33e1004d2f0dc71c986bc9500c60255d7 |
|
MD5 | f1da976c95f892fc8146f431d6a649b1 |
|
BLAKE2b-256 | 0d375a207664a92ffcc69efd851611f822a6c26edaa8f734aece39e9185a67af |
Hashes for sphinxcontrib_astah-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8177a8e955f7e331ccf631988d7af9f2b229216da91c980bac3b5dcd2c7bd28 |
|
MD5 | d3b2d2b4f5e6b32ea9154c24a84347dd |
|
BLAKE2b-256 | ce9a01a32c6a38058b88dbac45c82c99175cbb4d8fe9048828654727a8641949 |