sphinx扩展,用于生成硬件在hwt中编写的交互式原理图
sphinx-hwt的Python项目详细描述
狮身人面像
Sphinx文档生成器的扩展。添加自动生成的硬件方案和其他可视化文档。 目前主要用于HWT library(但vhdl、verilog->;hwt是可能的)。
live demo是hwtLib library的文档,这个库包含许多组件。原理图在组件文档中,例如在CRC generator文档中。
安装
使用pip作为标准python包安装。如果您在包中安装了npm,javascript将被更新。
pip3 install sphinx-hwt
Sphinx HWT包为Sphinx Doc提供Sphinx_HWT扩展。gen.要使用这个扩展,您必须在conf.py sphinx文档中注册。配置。
extensions=['sphinx_hwt']
从现在开始,sphinx将能够使用sphinx hwt的指令来呈现示意图和其他内容。
用法
像这样在单元类的docstring中添加hwt schematic指令。
fromhwt.synthesizer.unitimportUnitclassExampleCls0(Unit):""" .. hwt-schematic:: """
原理图上的链接将添加到类文档中。
功能列表
- 生成单元实例的交互原理图(=verilog中的模块,vhdl中的实体+架构)。
- 缩放、平移、动态缩放、网络选择、搜索和筛选
- 由d3-hwschematic library 呈现的示意图
- 通过hwtGraph library 将单元实例转换为图形
近功能列表(将在2018-8-xx中添加)
- 信号波由d3-wave library