sphinx扩展,用于生成硬件在hwt中编写的交互式原理图

sphinx-hwt的Python项目详细描述


狮身人面像

Travis-ci Build StatusPyPI versionCoverage StatusDocumentation StatusPython version

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中的实体+架构)。

近功能列表(将在2018-8-xx中添加)

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
检查java中两个链表之间的子集   java仅在findViewById()下显示一个ImageButton   在Java Graphics2D中,文本如何在矩形上居中对齐?   java需要一个用于电子表格计算器的正则表达式   ^java中的运算符   java通过一些属性配置文件根据环境动态更改wsdl端点URL   java Ebean/Play框架关系未更新   集合如何将POJO列表转换为Java流中的映射<String,List>?   java为什么JFrame不显示整个图像?   java如何将调用静态导入的泛型方法的结果传递给另一个方法?   迭代器或foreach中的java延迟   需要java socket logback日志接收器   在Java中初始化Map的静态数组   雅加达邮件Java MimeMail:解码后获得额外字符   java为什么这个xmldom解析器不能正确解析rtept、name和cmt标记?   java如何刷新Log4J2中的异步记录器(带中断器)   java使用构建插件pom生成的jar。xml作为同一pom中的依赖项   java基于位置的序列ADT如何在O(1)时间内插入元素?   java ORM实体与DDD实体   Java对象分配