Generate diagrams from HDL in Sphinx.
Project description
Sphinx Extension which generates various types of diagrams from HDL code, supporting Verilog, nMigen and RTLIL.
sphinxcontrib-hdl-diagrams is a Sphinx extension to make it easier to write nice documentation from HDL source files. It primarily uses Yosys to read the source files and generate the diagrams.
Check out the documentation for examples.
Installation
Python 3.5+ is required.
pip install sphinxcontrib-hdl-diagrams
Or,
python3 -m pip install sphinxcontrib-hdl-diagrams
Sphinx Integration
In your conf.py, add the following lines.
extensions = [
...,
'sphinxcontrib_hdl_diagrams',
]
Non-Python Dependencies
These dependencies can be either installed on your system or install using the conda environment.yml file with;
conda XXXX
Required
By default, verilog-diagram uses the yowasp-yosys package provided in PyPI. It can be installed by running pip install -r requirements.txt. However, you could also use Yosys that is installed on your system, or point to the specific Yosys binary using verilog_diagram_yosys variable in the Sphinx conf.py file:
To use Yosys that is available in your system, use the following setting:
verilog_diagram_yosys = "system"
If you want to point to the specific Yosys binary, provide the path to the program:
verilog_diagram_yosys = "<path-to-Yosys>"
Optional
Usage
hdl-diagram
The hdl-diagram RST directive can be used to generate a diagram from Verilog code and include it in your documentation. Check out the examples to see how to use it.
.. hdl-diagram:: file.v
:type: XXXXX
:module: XXXX
:skin: XXXX
:yosys_script: XXXX
:flatten:
Options
:type: - HDL Diagram Types;
yosys-blackbox - Netlist rendered by Yosys.
yosys-aig - Verilog file run through aigmap before image is generated directly in Yosys.
netlistsvg - Render output with netlistsvg
:module: - Which module to diagram.
:flatten: - Use the Yosys flatten command before generating the image.
Example
Here is a diagram of a 4-bit carry chain.
no-license
This extension also provides the no-license directive which can be used to include code blocks from a file, but omitting the license header at the top of the file. It behaves like the literalinclude directive, but the lines option is overridden to only show the lines after the license header.
.. no-license:: verilog/dff.v
:language: verilog
:linenos:
:caption: verilog/dff.v
Example
Here is a comparison between the literalinclude and no-license directives.
.. literalinclude:: verilog/dff.v
:language: verilog
:caption: verilog/dff.v
/*
* Copyright (C) 2020 The SymbiFlow Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
*/
// Single flip-flip test.
module top(input clk, input di, output do);
always @( posedge clk )
do <= di;
endmodule // top
.. no-license:: verilog/dff.v
:language: verilog
:caption: verilog/dff.v
// Single flip-flip test.
module top(input clk, input di, output do);
always @( posedge clk )
do <= di;
endmodule // top
Licence
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.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-hdl-diagrams-0.0.post127.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57edd268f85f03b8d3b5e06e4191922475a2748ac5372877958b9373ffffc760 |
|
MD5 | cdaf5c7a8291ec874165b1271432d065 |
|
BLAKE2b-256 | 423fe94c3289542af24c2b7a0c0c63176360e9f97642b7822311741a5e74001f |
Hashes for sphinxcontrib_hdl_diagrams-0.0.post127-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e133b36a1890be47e88d8e481254106294834f55505a9f14875b7b406d6f9328 |
|
MD5 | a18d87fe330c13314a0cfb04ca7884dc |
|
BLAKE2b-256 | 32b4af604781d05d7ec013edb5f7ca51076b87da4cc7a1772b1ab01974bb72da |