Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Sphinx "cacoo" extension; embed diagram from cacoo

Project description


This Sphinx extension allows you to embed diagrams on cacoo into your document:

.. image::

.. figure::

   caption of figure



$ pip install sphinxcontrib-cacoo

Configure Sphinx

Add sphinxcontrib.cacoo to extensions at

extensions += ['sphinxcontrib.cacoo']

And set your API key to cacoo_apikey:

cacoo_apikey = 'your apikey'


Please give an URL of caoo diagrams to image or figure directives as an argument:

.. image::

.. figure::

   caption of figure


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 #.


.. cacoo-image::

.. cacoo-image::

Options are same as image directive .

.. cacoo-figure:: [URL]

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


.. cacoo-figure::

   Structure of this system

Options are same as figure directive .

Configuration Options


The API key for cacoo

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-cacoo, version 2.0.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_cacoo-2.0.0-py2.py3-none-any.whl (3.9 kB) File type Wheel Python version 3.6 Upload date Hashes View hashes
Filename, size sphinxcontrib-cacoo-2.0.0.tar.gz (4.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page