Skip to main content

Sphinx "cacoo" extension; embed diagram from cacoo

Project description

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

.. _cacoo:



.. code-block:: bash

$ pip install sphinxcontrib-cacoo

Configure Sphinx

Add ``sphinxcontrib.cacoo`` to ``extensions`` at :file:`` .

.. code-block:: python

extensions += ['sphinxcontrib.cacoo']

And set your API key to ``cacoo_apikey`` .

.. code-block:: python

cacoo_apikey = 'your apikey'


.. describe:: .. cacoo-image:: [diagramid]

This directive insert a diagram into the document.
If your diagram has multiple sheets, specify sheetid after ``#``.


.. cacoo-image:: EWHRuF5Kox1AnyNL

.. cacoo-image:: mb53vvmYG38QGUPf#37D74

Options are same as `image directive`_ .

.. describe:: .. cacoo-figure:: [diagramid]

This directive insert a diagram and its caption into the document.


.. cacoo-figure:: EWHRuF5Kox1AnyNL

Structure of this system

Options are same as `figure directive`_ .

.. _image directive:
.. _figure directive:

Configuration Options

.. describe:: cacoo_apikey

API key for cacoo_


This code is hosted by Bitbucket.

Project details

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page