Sphinx "cacoo" extension; embed diagram from cacoo
Project description
sphinxcontrib-cacoo
This Sphinx extension allows you to embed diagrams on cacoo into your document:
.. image:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL .. figure:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL 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'
Usage
Please give an URL of caoo diagrams to image or figure directives as an argument:
.. image:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL .. figure:: https://cacoo.com/diagrams/EWHRuF5Kox1AnyNL caption of figure
Directives
For backward compatibility, this extension provides following two dirctives.
.. 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
The API key for cacoo
Repository
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-2.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0fea919e7530ba81fe9a6dfe8584819ecea23dc3f76b62cf13fdd75383ffdb18 |
|
MD5 | 0b91b2f763787f16270f622e80c9e260 |
|
BLAKE2b-256 | 45c2d564973b6edf1809dac533da4dfb0d23695cf5e722b7dc15e8efd91ef3c3 |
Hashes for sphinxcontrib_cacoo-2.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffa6241d08828a2126452e53f47ced68baba2c1da154ba15d36b874f1079ee15 |
|
MD5 | 7a824bc6373ce32ca3dc5e728b8cfd9b |
|
BLAKE2b-256 | 9062b530e9f484d54c9a3b4443c6f59e8730fd0b6301b8172e9bbaa34ce78b71 |