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
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-cacoo 2.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-cacoo-2.0.0.tar.gz | 4.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_cacoo-2.0.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 8.2 kB
Release files / sphinxcontrib-cacoo-2.0.0.tar.gz
| Download URL | sphinxcontrib-cacoo-2.0.0.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0fea919e7530ba81fe9a6dfe8584819ecea23dc3f76b62cf13fdd75383ffdb18
|
|
BLAKE2b-256 checksum How to use checksums |
45c2d564973b6edf1809dac533da4dfb0d23695cf5e722b7dc15e8efd91ef3c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sphinxcontrib_cacoo-2.0.0-py2.py3-none-any.whl
| Download URL | sphinxcontrib_cacoo-2.0.0-py2.py3-none-any.whl |
|---|---|
| Size | 3.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
ffa6241d08828a2126452e53f47ced68baba2c1da154ba15d36b874f1079ee15
|
|
BLAKE2b-256 checksum How to use checksums |
9062b530e9f484d54c9a3b4443c6f59e8730fd0b6301b8172e9bbaa34ce78b71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
