Skip to content

Commit d29884e

Browse files
Deploying to main from @ amaranth-lang/amaranth@369dc19 🚀
1 parent 2d3391a commit d29884e

35 files changed

+374
-374
lines changed

docs/amaranth/latest/_static/documentation_options.js

+1-1
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.6.0.dev66',
3+
VERSION: '0.6.0.dev67',
44
LANGUAGE: 'en',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

docs/amaranth/latest/changes.html

+7-7
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.6.0.dev66 documentation</title>
7+
<title>Changelog &mdash; Amaranth language &amp; toolchain 0.6.0.dev67 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=c0b5bcde"></script>
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=64cd38c7"></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.6.0.dev66
44+
0.6.0.dev67
4545
</div>
4646
<div role="search">
4747
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -208,7 +208,7 @@ <h3>Toolchain changes<a class="headerlink" href="#toolchain-changes" title="Perm
208208
<li><p>Changed: <code class="xref py py-meth docutils literal notranslate"><span class="pre">ResourceManager.add_clock_constraint</span></code> now accepts a <code class="xref py py-class docutils literal notranslate"><span class="pre">Period</span></code> for <code class="code highlight py python docutils literal highlight-python"><span class="n">period</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0066-simulation-time.html">RFC 66</a>)</p></li>
209209
<li><p>Changed: <code class="xref py py-class docutils literal notranslate"><span class="pre">Clock</span></code> now accepts a <code class="xref py py-class docutils literal notranslate"><span class="pre">Period</span></code> for <code class="code highlight py python docutils literal highlight-python"><span class="n">period</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0066-simulation-time.html">RFC 66</a>)</p></li>
210210
<li><p>Changed: <code class="xref py py-attr docutils literal notranslate"><span class="pre">Clock.period</span></code> now returns a <code class="xref py py-class docutils literal notranslate"><span class="pre">Period</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0066-simulation-time.html">RFC 66</a>)</p></li>
211-
<li><p>Deprecated: Passing a <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a> of seconds or hertz to any of the methods/arguments now accepting a <code class="xref py py-class docutils literal notranslate"><span class="pre">Period</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0066-simulation-time.html">RFC 66</a>)</p></li>
211+
<li><p>Deprecated: Passing a <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a> of seconds or hertz to any of the methods/arguments now accepting a <code class="xref py py-class docutils literal notranslate"><span class="pre">Period</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0066-simulation-time.html">RFC 66</a>)</p></li>
212212
<li><p>Deprecated: Passing <code class="code highlight py python docutils literal highlight-python"><span class="n">frequency</span><span class="o">=</span></code> to <code class="xref py py-meth docutils literal notranslate"><span class="pre">ResourceManager.add_clock_constraint</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0066-simulation-time.html">RFC 66</a>)</p></li>
213213
<li><p>Deprecated: Passing <code class="code highlight py python docutils literal highlight-python"><span class="n">frequency</span><span class="o">=</span></code> to <code class="xref py py-class docutils literal notranslate"><span class="pre">Clock</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0066-simulation-time.html">RFC 66</a>)</p></li>
214214
<li><p>Deprecated: <code class="xref py py-attr docutils literal notranslate"><span class="pre">Clock.frequency</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0066-simulation-time.html">RFC 66</a>)</p></li>
@@ -455,7 +455,7 @@ <h3>Language changes<a class="headerlink" href="#id12" title="Permalink to this
455455
<li><p>Added: <code class="xref py py-class docutils literal notranslate"><span class="pre">Memory</span></code> supports transparent read ports with read enable.</p></li>
456456
<li><p>Changed: creating a <code class="xref py py-class docutils literal notranslate"><span class="pre">Signal</span></code> with a shape that is a <a class="reference internal" href="reference.html#amaranth.hdl.ShapeCastable" title="amaranth.hdl.ShapeCastable"><code class="xref py py-class docutils literal notranslate"><span class="pre">ShapeCastable</span></code></a> implementing <a class="reference internal" href="reference.html#amaranth.hdl.ShapeCastable.__call__" title="amaranth.hdl.ShapeCastable.__call__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ShapeCastable.__call__()</span></code></a> wraps the returned object using that method. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0015-lifting-shape-castables.html">RFC 15</a>)</p></li>
457457
<li><p>Changed: <a class="reference internal" href="reference.html#amaranth.hdl.Value.cast" title="amaranth.hdl.Value.cast"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.cast()</span></code></a> casts <a class="reference internal" href="reference.html#amaranth.hdl.ValueCastable" title="amaranth.hdl.ValueCastable"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueCastable</span></code></a> objects recursively.</p></li>
458-
<li><p>Changed: <a class="reference internal" href="reference.html#amaranth.hdl.Value.cast" title="amaranth.hdl.Value.cast"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.cast()</span></code></a> treats instances of classes derived from both <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></a> and <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a> (including <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.IntEnum" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.IntEnum</span></code></a>) as enumerations rather than integers.</p></li>
458+
<li><p>Changed: <a class="reference internal" href="reference.html#amaranth.hdl.Value.cast" title="amaranth.hdl.Value.cast"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.cast()</span></code></a> treats instances of classes derived from both <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></a> and <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a> (including <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.IntEnum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.IntEnum</span></code></a>) as enumerations rather than integers.</p></li>
459459
<li><p>Changed: <a class="reference internal" href="reference.html#amaranth.hdl.Value.matches" title="amaranth.hdl.Value.matches"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.matches()</span></code></a> with an empty list of patterns returns <code class="docutils literal notranslate"><span class="pre">Const(1)</span></code> rather than <code class="docutils literal notranslate"><span class="pre">Const(0)</span></code>, to match the behavior of <code class="docutils literal notranslate"><span class="pre">with</span> <span class="pre">m.Case():</span></code>.</p></li>
460460
<li><p>Changed: <code class="xref py py-func docutils literal notranslate"><span class="pre">Cat()</span></code> warns if an enumeration without an explicitly specified shape is used. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0003-enumeration-shapes.html">RFC 3</a>)</p></li>
461461
<li><p>Changed: <code class="docutils literal notranslate"><span class="pre">signed(0)</span></code> is no longer constructible. (The semantics of this shape were never defined.)</p></li>
@@ -492,7 +492,7 @@ <h3>Toolchain changes<a class="headerlink" href="#id14" title="Permalink to this
492492
<li><p>Removed: (deprecated in 0.3) <code class="xref py py-meth docutils literal notranslate"><span class="pre">sim.Simulator.step()</span></code>.</p></li>
493493
<li><p>Removed: (deprecated in 0.3) <code class="xref py py-mod docutils literal notranslate"><span class="pre">back.pysim</span></code>.</p></li>
494494
<li><p>Removed: (deprecated in 0.3) support for invoking <code class="xref py py-func docutils literal notranslate"><span class="pre">back.rtlil.convert()</span></code> and <code class="xref py py-func docutils literal notranslate"><span class="pre">back.verilog.convert()</span></code> without an explicit <cite>ports=</cite> argument.</p></li>
495-
<li><p>Removed: (deprecated in 0.3) <a class="reference external" href="https://docs.python.org/3/library/test.html#module-test" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">test</span></code></a>.</p></li>
495+
<li><p>Removed: (deprecated in 0.3) <a class="reference external" href="https://docs.python.org/3/library/test.html#module-test" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">test</span></code></a>.</p></li>
496496
</ul>
497497
</section>
498498
<section id="id15">
@@ -533,7 +533,7 @@ <h3>Migrating from version 0.2<a class="headerlink" href="#migrating-from-versio
533533
<section id="id16">
534534
<h3>Language changes<a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
535535
<ul class="simple">
536-
<li><p>Added: <a class="reference internal" href="reference.html#amaranth.hdl.Value" title="amaranth.hdl.Value"><code class="xref py py-class docutils literal notranslate"><span class="pre">Value</span></code></a> can be used with <a class="reference external" href="https://docs.python.org/3/library/functions.html#abs" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">abs()</span></code></a>.</p></li>
536+
<li><p>Added: <a class="reference internal" href="reference.html#amaranth.hdl.Value" title="amaranth.hdl.Value"><code class="xref py py-class docutils literal notranslate"><span class="pre">Value</span></code></a> can be used with <a class="reference external" href="https://docs.python.org/3/library/functions.html#abs" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">abs()</span></code></a>.</p></li>
537537
<li><p>Added: <a class="reference internal" href="reference.html#amaranth.hdl.Value.rotate_left" title="amaranth.hdl.Value.rotate_left"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.rotate_left()</span></code></a> and <a class="reference internal" href="reference.html#amaranth.hdl.Value.rotate_right" title="amaranth.hdl.Value.rotate_right"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.rotate_right()</span></code></a>.</p></li>
538538
<li><p>Added: <a class="reference internal" href="reference.html#amaranth.hdl.Value.shift_left" title="amaranth.hdl.Value.shift_left"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.shift_left()</span></code></a> and <a class="reference internal" href="reference.html#amaranth.hdl.Value.shift_right" title="amaranth.hdl.Value.shift_right"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.shift_right()</span></code></a>.</p></li>
539539
<li><p>Added: <a class="reference internal" href="reference.html#amaranth.hdl.ValueCastable" title="amaranth.hdl.ValueCastable"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueCastable</span></code></a>.</p></li>

docs/amaranth/latest/contrib.html

+4-4
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.6.0.dev66 documentation</title>
7+
<title>Contributing &mdash; Amaranth language &amp; toolchain 0.6.0.dev67 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=c0b5bcde"></script>
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=64cd38c7"></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.6.0.dev66
43+
0.6.0.dev67
4444
</div>
4545
<div role="search">
4646
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -141,7 +141,7 @@ <h3>Preparing the environment<a class="headerlink" href="#preparing-the-environm
141141
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>pdm<span class="w"> </span>install<span class="w"> </span>--dev
142142
</pre></div>
143143
</div>
144-
<p>This command creates a <a class="reference external" href="https://docs.python.org/3/tutorial/venv.html#tut-venv" title="(in Python v3.12)"><span class="xref std std-ref">virtual environment</span></a> located at <code class="docutils literal notranslate"><span class="pre">./.venv/</span></code> and installs the runtime dependencies of Amaranth as well as the necessary development tools in it.</p>
144+
<p>This command creates a <a class="reference external" href="https://docs.python.org/3/tutorial/venv.html#tut-venv" title="(in Python v3.13)"><span class="xref std std-ref">virtual environment</span></a> located at <code class="docutils literal notranslate"><span class="pre">./.venv/</span></code> and installs the runtime dependencies of Amaranth as well as the necessary development tools in it.</p>
145145
<p>Amaranth itself is installed in the <em>editable mode</em>, meaning that the changes to its source files are immediately reflected in running the tests and documentation. However, other changes (addition or removal of source files, or changes to dependencies) will not be picked up, and it is a good habit to run <code class="docutils literal notranslate"><span class="pre">pdm</span> <span class="pre">install</span></code> each time after updating the source tree.</p>
146146
</section>
147147
<section id="running-the-testsuite">

docs/amaranth/latest/cover.html

+3-3
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>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.6.0.dev66 documentation</title>
7+
<title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.6.0.dev67 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=c0b5bcde"></script>
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=64cd38c7"></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.6.0.dev66
43+
0.6.0.dev67
4444
</div>
4545
<div role="search">
4646
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">

docs/amaranth/latest/genindex.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Index &mdash; Amaranth language &amp; toolchain 0.6.0.dev66 documentation</title>
6+
<title>Index &mdash; Amaranth language &amp; toolchain 0.6.0.dev67 documentation</title>
77
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
88
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
99
<link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
@@ -16,7 +16,7 @@
1616

1717
<script src="_static/jquery.js?v=5d32c60e"></script>
1818
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
19-
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=c0b5bcde"></script>
19+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=64cd38c7"></script>
2020
<script src="_static/doctools.js?v=888ff710"></script>
2121
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
2222
<script src="_static/platformpicker.js"></script>
@@ -38,7 +38,7 @@
3838
<img src="_static/logo.png" class="logo" alt="Logo"/>
3939
</a>
4040
<div class="version">
41-
0.6.0.dev66
41+
0.6.0.dev67
4242
</div>
4343
<div role="search">
4444
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">

0 commit comments

Comments
 (0)