Sphinx "cacoo" extension; embed diagram from cacoo
Project description
sphinxcontrib-cacoo
This package contains the cacoo Sphinx extension.
This extension enable you to embed diagrams on cacoo . Following code is sample:
.. cacoo-image:: [diagramid] .. cacoo-figure:: [diagramid] caption of figure
Setting
Install
$ pip install sphinxcontrib-cacoo
Configure Sphinx
Add sphinxcontrib.cacoo to extensions at conf.py:
extensions += ['sphinxcontrib.cacoo']
And set your API key to cacoo_apikey:
cacoo_apikey = 'your apikey'
Directive
.. cacoo-image:: [URL]
This directive insert a diagram into the document. If your diagram has multiple sheets, specify sheetid after #.
Examples:
.. cacoo-image:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL .. cacoo-image:: https://cacoo.com/diagrams/mb53vvmYG38QGUPf#37D74Options are same as image directive .
.. cacoo-figure:: [URL]
This directive insert a diagram and its caption into the document.
Examples:
.. cacoo-figure:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL Structure of this systemOptions are same as figure directive .
Configuration Options
cacoo_apikey
API key for cacoo
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-cacoo-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4859e9e69801ec9b0230937369e08868c5d913b306f67d99041db0566ba402b8 |
|
MD5 | e6da0fda3f932b003f4a36eca44f2e81 |
|
BLAKE2b-256 | 33fed9a57a87c10afa93d86be0c132b4ad613a85e7a0fe852a9d80a3d10a9e5a |
Hashes for sphinxcontrib_cacoo-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba5b0675f61db0b31535286b2b7c1361d38956d3b58b1a9099362001ec967793 |
|
MD5 | 301a8c30505d4225f562de86982645e1 |
|
BLAKE2b-256 | 270b50ba4f176fdb1cf67e644bc7eb0e6fb11b30066c009f10f35d1eae265ced |