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-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)
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-astah 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib-astah-1.0.0.tar.gz | 4.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 10.3 kB
Release files / sphinxcontrib-astah-1.0.0.tar.gz
| Download URL | sphinxcontrib-astah-1.0.0.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
beadc20daa10d3a0553fbde29a854a1e943435b15012b18740d71cd466e676a4
|
|
BLAKE2b-256 checksum How to use checksums |
ee632bd48b01ffde744593f1a08f4ceb76d09bc29c49481748ea181b98dbf3fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl
| Download URL | sphinxcontrib_astah-1.0.0-py2.py3-none-any.whl |
|---|---|
| Size | 6.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
a6a023c0d881b5e567d0ef0b48e632a333401553a864e7644685dc91931fd6dc
|
|
BLAKE2b-256 checksum How to use checksums |
d31ca66dbd492ec653f0e1d5950acced60958853bc02e9642c713ef46d693957
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
