Sphinx extension to produce interactive schematic for hardware written in HWT
Project description
sphinx-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).
Live demo is documentation of hwtLib library, this library contains many components. The schematic is in documentation of compoents for example there in documentation of CRC generator.
Installation
Install as standard python package, using pip. If you have NPM installed javascript in package will be updated.
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.
Usage
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.
Feature list
- generate interactive schematic for Unit instances (= module in verilog, entity + architecutere in VHDL).
- zoom, pan, dynamic colapsing, net-select, searching and filtering
- schematic rendered by d3-hwschematic library
- Unit instances to graph conversion by hwtGraph library
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.