Skip to content

Commit 47dea6f

Browse files
Deploying to main from @ amaranth-lang/amaranth@6d7b17e 🚀
1 parent 275af53 commit 47dea6f

Some content is hidden

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

48 files changed

+186
-510
lines changed

docs/amaranth/latest/.buildinfo

+1-1
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: d34c43b1918f968f1ed0e01e3aa4d36d
3+
config: 391232d3b3dd4007ee8c67d2f4f82791
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
2.43 KB
Binary file not shown.
-41.2 KB
Binary file not shown.
-431 Bytes
Binary file not shown.
Binary file not shown.

docs/amaranth/latest/_sources/changes.rst.txt

+13
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Documentation for past releases
99

1010
Documentation for past releases of the Amaranth language and toolchain is available online:
1111

12+
* `Amaranth 0.5.0 <https://amaranth-lang.org/docs/amaranth/v0.5.0/>`_
1213
* `Amaranth 0.4.5 <https://amaranth-lang.org/docs/amaranth/v0.4.5/>`_
1314
* `Amaranth 0.4.4 <https://amaranth-lang.org/docs/amaranth/v0.4.4/>`_
1415
* `Amaranth 0.4.3 <https://amaranth-lang.org/docs/amaranth/v0.4.3/>`_
@@ -18,6 +19,18 @@ Documentation for past releases of the Amaranth language and toolchain is availa
1819
* `Amaranth 0.3 <https://amaranth-lang.org/docs/amaranth/v0.3/>`_
1920

2021

22+
Version 0.6 (unreleased)
23+
========================
24+
25+
26+
Standard library changes
27+
------------------------
28+
29+
.. currentmodule:: amaranth.lib
30+
31+
* Removed: (deprecated in 0.5) :mod:`amaranth.lib.coding`. (`RFC 63`_)
32+
33+
2134
Version 0.5
2235
===========
2336

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The :mod:`amaranth.lib` module, also known as the standard library, provides mod
55

66
1. Modules that will used by essentially all idiomatic Amaranth code, or which are necessary for interoperability. This includes :mod:`amaranth.lib.enum` (enumerations), :mod:`amaranth.lib.data` (data structures), :mod:`amaranth.lib.wiring` (interfaces and components), :mod:`amaranth.lib.meta` (interface metadata), and :mod:`amaranth.lib.stream` (data streams).
77
2. Modules that abstract common functionality whose implementation differs between hardware platforms. This includes :mod:`amaranth.lib.memory` and :mod:`amaranth.lib.cdc`.
8-
3. Modules that have essentially one correct implementation and are of broad utility in digital designs. This includes :mod:`amaranth.lib.coding`, :mod:`amaranth.lib.fifo`, and :mod:`amaranth.lib.crc`.
8+
3. Modules that have essentially one correct implementation and are of broad utility in digital designs. This includes :mod:`amaranth.lib.fifo`, and :mod:`amaranth.lib.crc`.
99

1010
As part of the Amaranth backwards compatibility guarantee, any behaviors described in these documents will not change from a version to another without at least one version including a warning about the impending change. Any nontrivial change to these behaviors must also go through the public review as a part of the `Amaranth Request for Comments process <https://amaranth-lang.org/rfcs/>`_.
1111

@@ -22,6 +22,5 @@ The Amaranth standard library is separate from the Amaranth language: everything
2222
stdlib/memory
2323
stdlib/io
2424
stdlib/cdc
25-
stdlib/coding
2625
stdlib/fifo
2726
stdlib/crc

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

-27
This file was deleted.

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

docs/amaranth/latest/changes.html

+48-34
Large diffs are not rendered by default.

docs/amaranth/latest/changes.rst

+13
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Documentation for past releases
99

1010
Documentation for past releases of the Amaranth language and toolchain is available online:
1111

12+
* `Amaranth 0.5.0 <https://amaranth-lang.org/docs/amaranth/v0.5.0/>`_
1213
* `Amaranth 0.4.5 <https://amaranth-lang.org/docs/amaranth/v0.4.5/>`_
1314
* `Amaranth 0.4.4 <https://amaranth-lang.org/docs/amaranth/v0.4.4/>`_
1415
* `Amaranth 0.4.3 <https://amaranth-lang.org/docs/amaranth/v0.4.3/>`_
@@ -18,6 +19,18 @@ Documentation for past releases of the Amaranth language and toolchain is availa
1819
* `Amaranth 0.3 <https://amaranth-lang.org/docs/amaranth/v0.3/>`_
1920

2021

22+
Version 0.6 (unreleased)
23+
========================
24+
25+
26+
Standard library changes
27+
------------------------
28+
29+
.. currentmodule:: amaranth.lib
30+
31+
* Removed: (deprecated in 0.5) :mod:`amaranth.lib.coding`. (`RFC 63`_)
32+
33+
2134
Version 0.5
2235
===========
2336

docs/amaranth/latest/contrib.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>Contributing &mdash; Amaranth language &amp; toolchain 0.5.0.dev1 documentation</title>
7+
<title>Contributing &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 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=8f0cda3f"></script>
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></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.dev1
43+
0.6.0.dev1
4444
</div>
4545
<div role="search">
4646
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">

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.5.0.dev1 documentation</title>
7+
<title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 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=8f0cda3f"></script>
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></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.dev1
43+
0.6.0.dev1
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

+8-29
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.5.0.dev1 documentation</title>
6+
<title>Index &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 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=8f0cda3f"></script>
19+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></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.5.0.dev1
41+
0.6.0.dev1
4242
</div>
4343
<div role="search">
4444
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -346,13 +346,6 @@ <h2 id="A">A</h2>
346346

347347
<ul>
348348
<li><a href="stdlib/cdc.html#module-amaranth.lib.cdc">module</a>
349-
</li>
350-
</ul></li>
351-
<li>
352-
amaranth.lib.coding
353-
354-
<ul>
355-
<li><a href="stdlib/coding.html#module-amaranth.lib.coding">module</a>
356349
</li>
357350
</ul></li>
358351
<li>
@@ -404,15 +397,15 @@ <h2 id="A">A</h2>
404397
<li><a href="stdlib/memory.html#module-amaranth.lib.memory">module</a>
405398
</li>
406399
</ul></li>
407-
</ul></td>
408-
<td style="width: 33%; vertical-align: top;"><ul>
409400
<li>
410401
amaranth.lib.meta
411402

412403
<ul>
413404
<li><a href="stdlib/meta.html#module-amaranth.lib.meta">module</a>
414405
</li>
415406
</ul></li>
407+
</ul></td>
408+
<td style="width: 33%; vertical-align: top;"><ul>
416409
<li>
417410
amaranth.lib.stream
418411

@@ -873,8 +866,6 @@ <h2 id="D">D</h2>
873866
<li><a href="stdlib/io.html#amaranth.lib.io.DDRBuffer">DDRBuffer (class in amaranth.lib.io)</a>
874867
</li>
875868
<li><a href="stdlib/io.html#amaranth.lib.io.DDRBuffer.Signature">DDRBuffer.Signature (class in amaranth.lib.io)</a>
876-
</li>
877-
<li><a href="stdlib/coding.html#amaranth.lib.coding.Decoder">Decoder (class in amaranth.lib.coding)</a>
878869
</li>
879870
<li><a href="simulator.html#amaranth.sim.SimulatorContext.delay">delay() (amaranth.sim.SimulatorContext method)</a>
880871

@@ -906,14 +897,12 @@ <h2 id="E">E</h2>
906897
<li><a href="simulator.html#amaranth.sim.TriggerCombination.edge">(amaranth.sim.TriggerCombination method)</a>
907898
</li>
908899
</ul></li>
909-
<li><a href="stdlib/coding.html#amaranth.lib.coding.Encoder">Encoder (class in amaranth.lib.coding)</a>
910-
</li>
911900
<li><a href="stdlib/enum.html#amaranth.lib.enum.Enum">Enum (class in amaranth.lib.enum)</a>
912901
</li>
913-
</ul></td>
914-
<td style="width: 33%; vertical-align: top;"><ul>
915902
<li><a href="stdlib/enum.html#amaranth.lib.enum.EnumType">EnumType (class in amaranth.lib.enum)</a>
916903
</li>
904+
</ul></td>
905+
<td style="width: 33%; vertical-align: top;"><ul>
917906
<li><a href="stdlib/enum.html#amaranth.lib.enum.EnumView">EnumView (class in amaranth.lib.enum)</a>
918907
</li>
919908
<li><a href="reference.html#amaranth.hdl.Value.eq">eq() (amaranth.hdl.Value method)</a>
@@ -995,14 +984,10 @@ <h2 id="G">G</h2>
995984
<table style="width: 100%" class="indextable genindextable"><tr>
996985
<td style="width: 33%; vertical-align: top;"><ul>
997986
<li><a href="simulator.html#amaranth.sim.SimulatorContext.get">get() (amaranth.sim.SimulatorContext method)</a>
998-
</li>
999-
<li><a href="platform/gowin.html#amaranth.vendor.GowinPlatform">GowinPlatform (class in amaranth.vendor)</a>
1000987
</li>
1001988
</ul></td>
1002989
<td style="width: 33%; vertical-align: top;"><ul>
1003-
<li><a href="stdlib/coding.html#amaranth.lib.coding.GrayDecoder">GrayDecoder (class in amaranth.lib.coding)</a>
1004-
</li>
1005-
<li><a href="stdlib/coding.html#amaranth.lib.coding.GrayEncoder">GrayEncoder (class in amaranth.lib.coding)</a>
990+
<li><a href="platform/gowin.html#amaranth.vendor.GowinPlatform">GowinPlatform (class in amaranth.vendor)</a>
1006991
</li>
1007992
</ul></td>
1008993
</tr></table>
@@ -1079,8 +1064,6 @@ <h2 id="M">M</h2>
10791064
<li><a href="reference.html#module-amaranth.hdl">amaranth.hdl</a>
10801065
</li>
10811066
<li><a href="stdlib/cdc.html#module-amaranth.lib.cdc">amaranth.lib.cdc</a>
1082-
</li>
1083-
<li><a href="stdlib/coding.html#module-amaranth.lib.coding">amaranth.lib.coding</a>
10841067
</li>
10851068
<li><a href="stdlib/crc.html#module-amaranth.lib.crc">amaranth.lib.crc</a>
10861069
</li>
@@ -1159,10 +1142,6 @@ <h2 id="P">P</h2>
11591142
</ul></li>
11601143
</ul></td>
11611144
<td style="width: 33%; vertical-align: top;"><ul>
1162-
<li><a href="stdlib/coding.html#amaranth.lib.coding.PriorityDecoder">PriorityDecoder (class in amaranth.lib.coding)</a>
1163-
</li>
1164-
<li><a href="stdlib/coding.html#amaranth.lib.coding.PriorityEncoder">PriorityEncoder (class in amaranth.lib.coding)</a>
1165-
</li>
11661145
<li><a href="stdlib/crc.html#amaranth.lib.crc.Processor">Processor (class in amaranth.lib.crc)</a>
11671146
</li>
11681147
<li><a href="stdlib/cdc.html#amaranth.lib.cdc.PulseSynchronizer">PulseSynchronizer (class in amaranth.lib.cdc)</a>

docs/amaranth/latest/guide.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>Language guide &mdash; Amaranth language &amp; toolchain 0.5.0.dev1 documentation</title>
7+
<title>Language guide &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 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=8f0cda3f"></script>
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></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.dev1
44+
0.6.0.dev1
4545
</div>
4646
<div role="search">
4747
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">

docs/amaranth/latest/index.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>Language &amp; toolchain &mdash; Amaranth language &amp; toolchain 0.5.0.dev1 documentation</title>
7+
<title>Language &amp; toolchain &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 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=8f0cda3f"></script>
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></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.dev1
44+
0.6.0.dev1
4545
</div>
4646
<div role="search">
4747
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -167,7 +167,6 @@ <h1>Language &amp; toolchain<a class="headerlink" href="#language-toolchain" tit
167167
<li class="toctree-l2"><a class="reference internal" href="stdlib/memory.html">Memory arrays</a></li>
168168
<li class="toctree-l2"><a class="reference internal" href="stdlib/io.html">Input/output buffers</a></li>
169169
<li class="toctree-l2"><a class="reference internal" href="stdlib/cdc.html">Clock domain crossing</a></li>
170-
<li class="toctree-l2"><a class="reference internal" href="stdlib/coding.html">Code conversion</a></li>
171170
<li class="toctree-l2"><a class="reference internal" href="stdlib/fifo.html">First-in first-out queues</a></li>
172171
<li class="toctree-l2"><a class="reference internal" href="stdlib/crc.html">Cyclic redundancy checks</a></li>
173172
</ul>
@@ -189,6 +188,7 @@ <h1>Language &amp; toolchain<a class="headerlink" href="#language-toolchain" tit
189188
</li>
190189
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changelog</a><ul>
191190
<li class="toctree-l2"><a class="reference internal" href="changes.html#documentation-for-past-releases">Documentation for past releases</a></li>
191+
<li class="toctree-l2"><a class="reference internal" href="changes.html#version-0-6-unreleased">Version 0.6 (unreleased)</a></li>
192192
<li class="toctree-l2"><a class="reference internal" href="changes.html#version-0-5">Version 0.5</a></li>
193193
<li class="toctree-l2"><a class="reference internal" href="changes.html#version-0-4">Version 0.4</a></li>
194194
<li class="toctree-l2"><a class="reference internal" href="changes.html#version-0-3">Version 0.3</a></li>

docs/amaranth/latest/install.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>Installation &mdash; Amaranth language &amp; toolchain 0.5.0.dev1 documentation</title>
7+
<title>Installation &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 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=8f0cda3f"></script>
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></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.dev1
44+
0.6.0.dev1
4545
</div>
4646
<div role="search">
4747
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">

0 commit comments

Comments
 (0)