Skip to content

Commit 91221c3

Browse files
Deploying to main from @ amaranth-lang/amaranth@6fb5f3f 🚀
1 parent 06a2de9 commit 91221c3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+216
-227
lines changed

docs/amaranth/latest/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 4076b18fd408fa5510f14ff1673098af
3+
config: f93bf0f1860341e37c2fd56db2b980ea
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
2.67 KB
Binary file not shown.
2.7 KB
Binary file not shown.

docs/amaranth/latest/_images/example_fifo.svg

Lines changed: 0 additions & 41 deletions
This file was deleted.

docs/amaranth/latest/_images/example_hello.svg

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/amaranth/latest/_sources/stdlib/memory.rst.txt

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,25 @@ In the following example, a read-only memory is used to output a fixed message i
7474

7575
In this example, the memory read port is asynchronous, and a change of the address input (labelled `a` on the diagram below) results in an immediate change of the data output (labelled `d`).
7676

77-
.. image:: _images/memory/example_hello.svg
77+
.. wavedrom:: memory/example_hello
78+
79+
{
80+
"signal": [
81+
{"name": "clk",
82+
"wave": "0P............"},
83+
{"name": "rd_port.addr",
84+
"wave": "==============",
85+
"data": [0,1,2,3,4,5,6,7,8,9,10,11,0,1],
86+
"node": ".a"},
87+
{"name": "rd_port.data",
88+
"wave": "==============",
89+
"data": ["H","e","l","l","o"," ","w","o","r","l","d","\\n","H","e"],
90+
"node": ".d"}
91+
],
92+
"edge": [
93+
"a-|d"
94+
]
95+
}
7896
7997

8098
First-in, first-out queue
@@ -112,7 +130,44 @@ In this example, the memory read and write ports are synchronous. A write operat
112130

113131
However, the memory read port is also configured to be *transparent* relative to the memory write port. This means that if a write and a read operation (labelled `t`, `u` respectively) access the same row with address 3, the new contents will be read out, reducing the minimum push-to-pop latency to one cycle, down from two cycles that would be required without the use of transparency.
114132

115-
.. image:: _images/memory/example_fifo.svg
133+
.. wavedrom:: memory/example_fifo
134+
135+
{
136+
"signal": [
137+
{"name": "clk",
138+
"wave": "P........"},
139+
{"name": "push",
140+
"wave": "01..0.10.",
141+
"node": ".x"},
142+
{"name": "wr_port.addr",
143+
"wave": "=.===..=.",
144+
"data": ["0", "1", "2", "3", "4", "5"]},
145+
{"name": "wr_port.data",
146+
"wave": "====..=..",
147+
"data": ["00", "AA", "BB", "CC", "DD"],
148+
"node": ".w....t"},
149+
{"name": "memory[0]",
150+
"wave": "=.=......",
151+
"data": ["00", "AA"],
152+
"node": "..G"},
153+
{"name": "memory[3]",
154+
"wave": "=......=.",
155+
"data": ["00", "DD"],
156+
"node": ".......H"},
157+
{"name": "pop",
158+
"wave": "0..1...0.",
159+
"node": "...y"},
160+
{"name": "rd_port.addr",
161+
"wave": "=...====.",
162+
"data": ["0", "1", "2", "3", "4", "5"]},
163+
{"name": "rd_port.data",
164+
"wave": "=...====.",
165+
"data": ["00", "AA", "BB", "CC", "DD"],
166+
"node": "....r..u"}
167+
], "edge": [
168+
"x-~>G", "w->G", "y-~>r", "t->H", "t->u"
169+
]
170+
}
116171

117172

118173
Memories

docs/amaranth/latest/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '0.5.0.dev225',
3+
VERSION: '0.5.0.dev226',
44
LANGUAGE: 'en',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

docs/amaranth/latest/changes.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Changelog &mdash; Amaranth language &amp; toolchain 0.5.0.dev225 documentation</title>
7+
<title>Changelog &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010
<link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
@@ -17,7 +17,7 @@
1717

1818
<script src="_static/jquery.js?v=5d32c60e"></script>
1919
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=53ae257b"></script>
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></script>
2121
<script src="_static/doctools.js?v=888ff710"></script>
2222
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
2323
<script src="_static/platformpicker.js"></script>
@@ -41,7 +41,7 @@
4141
<img src="_static/logo.png" class="logo" alt="Logo"/>
4242
</a>
4343
<div class="version">
44-
0.5.0.dev225+g7936b87
44+
0.5.0.dev226+g6fb5f3f
4545
</div>
4646
<div role="search">
4747
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">

docs/amaranth/latest/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
"sphinx.ext.napoleon",
1818
"sphinx_rtd_theme",
1919
"sphinxcontrib.platformpicker",
20+
"sphinxcontrib.yowasp_wavedrom",
2021
]
2122

2223
with open(".gitignore") as f:
@@ -45,6 +46,8 @@
4546
"Platform overrides"
4647
]
4748

49+
yowasp_wavedrom_skin = "light"
50+
4851
html_theme = "sphinx_rtd_theme"
4952
html_static_path = ["_static"]
5053
html_css_files = ["custom.css"]

docs/amaranth/latest/contrib.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Contributing &mdash; Amaranth language &amp; toolchain 0.5.0.dev225 documentation</title>
7+
<title>Contributing &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010
<link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
@@ -17,7 +17,7 @@
1717

1818
<script src="_static/jquery.js?v=5d32c60e"></script>
1919
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=53ae257b"></script>
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></script>
2121
<script src="_static/doctools.js?v=888ff710"></script>
2222
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
2323
<script src="_static/platformpicker.js"></script>
@@ -40,7 +40,7 @@
4040
<img src="_static/logo.png" class="logo" alt="Logo"/>
4141
</a>
4242
<div class="version">
43-
0.5.0.dev225+g7936b87
43+
0.5.0.dev226+g6fb5f3f
4444
</div>
4545
<div role="search">
4646
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">

0 commit comments

Comments
 (0)