Add Wavedrom support
Overview
From the Wavedrom's Github repository:
WaveDrom is a Free and Open Source online digital timing diagram (waveform) rendering engine that uses javascript, HTML5 and SVG to convert a WaveJSON input text description into SVG vector graphics.
Rationale
Adding WaveDrom diagrams support improves the documentation by providing a text-based format which benefits from all the advantages of tight version control capabilties, as opposed to using a binary format.
Expected Hurdles
-
Copy in a third_party
directory the required Python packages not available in Safran's private Pypi index -
Update CI configuration script for installing these packages -
Setup the Material documentation framework -
Setup Mkdocs / Material for using a local copy of Wavedrom's script files -
Enable in-line Markdown syntax block with a relevant type tag
References
- Wavedrom's Github repository
- Mkdocs setup guide for Wavedrom support
- Material for Mkdocs' Github repository