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.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bf18e6fbaa8363a2c79b40d18716fd6d918e012cbf9ca811f8596ece30e94c5 |
|
MD5 | a1d31cb249bb0a471048e44be073f583 |
|
BLAKE2b-256 | bf067f3b612a69cd839ead660b3c0cc1061cc86eb0e4a49f9cf65551038bab7b |
Hashes for sphinxcontrib_cacoo-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c9b80f9066165e9565f23c8fc1918c818bccdaccdfe9df0283cef1f4bb059ee |
|
MD5 | 47526e901eaf044b52d2126ec9db1eda |
|
BLAKE2b-256 | 99ee436c18d4f6131171987825b058c53ef844c1e7cefb70291e3cd41d23deea |