Skip to main content

Sphinx extension to produce interactive schematic for hardware writen in HWT

Project description

sphinx-hwt

Travis-ci Build StatusPyPI versionCoverage StatusDocumentation Status Python version

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

Near feature list (will add in 2018-8-xx)

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinx-hwt-1.6.tar.gz (760.6 kB) Copy SHA256 hash SHA256 Source None

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