Sphinx extension to produce interactive schematic for hardware writen in HWT
Extension for Sphinx document generator. Add automatically generated schemes and other visual documentation of hardware. Currently mainly for HWT library (but VHDL,Verilog -> HWT is possible).
pip3 install sphinx-hwt
sphinx-hwt package provides sphinx_hwt extension for sphinx doc. gen. In order to use this extension you have to register in in your conf.py sphinx doc. configuration.
extensions = ['sphinx_hwt']
From now Sphinx will be able to use directives from sphinx-hwt to render schematics and others.
Add hwt-schematic directive in docstring of Unit class like this.
from hwt.synthesizer.unit import Unit class ExampleCls0(Unit): """ .. hwt-schematic:: """
Link on schematic will be added to class documentation.
- generate interactive schematic for Unit instances (= module in verilog, entity + architecutere in VHDL).
Near feature list (will add in 2018-8-xx)
- signal waves by d3-wave library