sphinxcontrib-wavedrom

Sphinx wavedrom extension

A sphinx extension that allows including wavedrom diagrams by using its text-based representation

Wavedrom online editor and tutorial: https://wavedrom.com/

.. image:: https://travis-ci.org/bavovanachte/sphinx-wavedrom.svg?branch=master :target: https://travis-ci.org/bavovanachte/sphinx-wavedrom

.. image:: https://badge.fury.io/py/sphinxcontrib-wavedrom.svg :target: https://badge.fury.io/py/sphinxcontrib-wavedrom

Installation

The wavedrom extension can be installed using pip:

::

pip install sphinxcontrib-wavedrom

and by adding 'sphinxcontrib.wavedrom' to the extensions list in your conf.py file.

Directives

The extension is useable in the form of an extra wavedrom directive, as shown below.

::

.. wavedrom::

	{ "signal": [
	  	{ "name": "clk",  "wave": "P......" },
	  	{ "name": "bus",  "wave": "x.==.=x", "data": ["head", "body", "tail", "data"] },
	  	{ "name": "wire", "wave": "0.1..0." }
	]}

Alternatively, it can read the json from a file:

::

.. wavedrom:: mywave.json

When configured to generate images (see Configuration_) the directive will generate an image and include it into the input. It allows for the same configuration as the image directive:

::

.. wavedrom:: mywave.json
    :height: 100px
    :width: 200 px
    :scale: 50 %
    :alt: alternate text
    :align: right

The image can be turned into a figure by adding a caption:

::

.. wavedrom:: mywave.json
    :caption: My wave figure

The extension can be configured (see Configuration_) to not generate an image out of the diagram description itself, but to surround it with some html and js tags in the final html document that allow the images to be rendered by the browser. This is the currently the default for HTML output.

Configuration

The following decision tree gives an overview of which configurations to make in different use cases:

.. image:: configuration.png :alt: Decision tree for configuration settings

The extension can be configured to either directly output images or by emitting the javascript to live-render the wavedrom code, which obviously only works for HTML output. All other outputs (most notably latexpdf) embed a generated image in any case, but this is only supported when using Python 3.

Depending on the output you're building, the plugin will automatically choose the appropriate image rendering method (HTML defaults to browser rendering, pdf to build-time image generation). You can force the generation of build-time images by adding the following configuration to your conf.py:

::

wavedrom_html_jsinline = False

This may be interesting in case you are building for various output targets and want to ensure consistent diagrams between all output formats

Build-time image generation through wavedrompy or wavedrom-cli

2 Tools are available for the build-time generation of images:

- `wavedrom-cli <https://github.com/wavedrom/cli>`_: The default builder. This is the tool maintained by the wavedrom
  team itself. More bloaty than wavedrompy as it requires node.js and npm to install and use, but more likely to render
  consistent images w.r.t. the browser-rendered version.
- `wavedrompy <https://github.com/wallento/wavedrompy>`_: A python "clone" of wavedrompy. The goal of the project is to
  stay as close as possible to the JS implementation, but offer a solution that doesn't require node.js or npm to be
  installed.

As mentioned, wavedrom-cli is the default builder. If you want to select wavedrompy instead, add
``render_using_wavedrompy = True`` to your ``conf.py``:

Wavedrompy is imported as a python module and requires no further configuration. Wavedrom-cli is executed using system
calls. The default command is `npx wavedrom-cli`, but this can be overwritten using the ``wavedrom_cli`` configuration
parameter in `conf.py`

Browser-rendered images through inline Javascript
`````````````````````````````````````````````````

When HTML building is configured to inline the javascript (default), the extension can work in 2 modes:

- Online mode: 	the extension links to the javascript file(s) hosted on the wavedrom server or your own server
- Offline mode: the extension uses the javascript file(s) that are saved locally on your drive.

The online mode is the default one. In case you want to use the js files hosted on the wavedrom server, no configuration
is needed. However, in case the desired JS files are hosted on a custom server (or on localhost) add the following to
conf.py:

- ``online_wavedrom_js_url`` : the url of the server hosting the javascript files. The plugin will look for 2 files:

	+ {online_wavedrom_js_url}/skins/default.js
	+ {online_wavedrom_js_url}/wavedrom.min.js

**Warning**: A full URI is needed when configuring. "http://www.google.com" will work but "www.google.com" won't.

If offline mode is desired, the following configuration parameters need to be provided:

- ``offline_skin_js_path`` : the path to the skin javascript file (the url to the online version is "https://wavedrom.com/skins/default.js")
- ``offline_wavedrom_js_path`` : the path to the wavedrom javascript file (the url to the online version is "https://wavedrom.com/wavedrom.min.js")

The paths given for these configurations need to be relative to the configuration directory (the directory that contains conf.py)


Examples
--------

In the `example` folder, you can find a couple of examples (taken from the wavedrom tutorial), illustration the use of the extension.