Skip to content

Commit

Permalink
Deploying to main from @ amaranth-lang/amaranth@6d7b17e 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Jun 14, 2024
1 parent 275af53 commit 47dea6f
Show file tree
Hide file tree
Showing 48 changed files with 186 additions and 510 deletions.
2 changes: 1 addition & 1 deletion docs/amaranth/latest/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d34c43b1918f968f1ed0e01e3aa4d36d
config: 391232d3b3dd4007ee8c67d2f4f82791
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/amaranth/latest/.doctrees/changes.doctree
Binary file not shown.
Binary file modified docs/amaranth/latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/amaranth/latest/.doctrees/stdlib.doctree
Binary file not shown.
Binary file removed docs/amaranth/latest/.doctrees/stdlib/coding.doctree
Binary file not shown.
13 changes: 13 additions & 0 deletions docs/amaranth/latest/_sources/changes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Documentation for past releases

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

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


Version 0.6 (unreleased)
========================


Standard library changes
------------------------

.. currentmodule:: amaranth.lib

* Removed: (deprecated in 0.5) :mod:`amaranth.lib.coding`. (`RFC 63`_)


Version 0.5
===========

Expand Down
3 changes: 1 addition & 2 deletions docs/amaranth/latest/_sources/stdlib.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The :mod:`amaranth.lib` module, also known as the standard library, provides mod

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).
2. Modules that abstract common functionality whose implementation differs between hardware platforms. This includes :mod:`amaranth.lib.memory` and :mod:`amaranth.lib.cdc`.
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`.
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`.

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/>`_.

Expand All @@ -22,6 +22,5 @@ The Amaranth standard library is separate from the Amaranth language: everything
stdlib/memory
stdlib/io
stdlib/cdc
stdlib/coding
stdlib/fifo
stdlib/crc
27 changes: 0 additions & 27 deletions docs/amaranth/latest/_sources/stdlib/coding.rst.txt

This file was deleted.

2 changes: 1 addition & 1 deletion docs/amaranth/latest/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.5.0.dev1',
VERSION: '0.6.0.dev1',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
82 changes: 48 additions & 34 deletions docs/amaranth/latest/changes.html

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions docs/amaranth/latest/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Documentation for past releases

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

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


Version 0.6 (unreleased)
========================


Standard library changes
------------------------

.. currentmodule:: amaranth.lib

* Removed: (deprecated in 0.5) :mod:`amaranth.lib.coding`. (`RFC 63`_)


Version 0.5
===========

Expand Down
6 changes: 3 additions & 3 deletions docs/amaranth/latest/contrib.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

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

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8f0cda3f"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/platformpicker.js"></script>
Expand All @@ -40,7 +40,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.5.0.dev1
0.6.0.dev1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
6 changes: 3 additions & 3 deletions docs/amaranth/latest/cover.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.5.0.dev1 documentation</title>
<title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
Expand All @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8f0cda3f"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/platformpicker.js"></script>
Expand All @@ -40,7 +40,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.5.0.dev1
0.6.0.dev1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
37 changes: 8 additions & 29 deletions docs/amaranth/latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; Amaranth language &amp; toolchain 0.5.0.dev1 documentation</title>
<title>Index &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
Expand All @@ -16,7 +16,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8f0cda3f"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/platformpicker.js"></script>
Expand All @@ -38,7 +38,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.5.0.dev1
0.6.0.dev1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -346,13 +346,6 @@ <h2 id="A">A</h2>

<ul>
<li><a href="stdlib/cdc.html#module-amaranth.lib.cdc">module</a>
</li>
</ul></li>
<li>
amaranth.lib.coding

<ul>
<li><a href="stdlib/coding.html#module-amaranth.lib.coding">module</a>
</li>
</ul></li>
<li>
Expand Down Expand Up @@ -404,15 +397,15 @@ <h2 id="A">A</h2>
<li><a href="stdlib/memory.html#module-amaranth.lib.memory">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
amaranth.lib.meta

<ul>
<li><a href="stdlib/meta.html#module-amaranth.lib.meta">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
amaranth.lib.stream

Expand Down Expand Up @@ -873,8 +866,6 @@ <h2 id="D">D</h2>
<li><a href="stdlib/io.html#amaranth.lib.io.DDRBuffer">DDRBuffer (class in amaranth.lib.io)</a>
</li>
<li><a href="stdlib/io.html#amaranth.lib.io.DDRBuffer.Signature">DDRBuffer.Signature (class in amaranth.lib.io)</a>
</li>
<li><a href="stdlib/coding.html#amaranth.lib.coding.Decoder">Decoder (class in amaranth.lib.coding)</a>
</li>
<li><a href="simulator.html#amaranth.sim.SimulatorContext.delay">delay() (amaranth.sim.SimulatorContext method)</a>

Expand Down Expand Up @@ -906,14 +897,12 @@ <h2 id="E">E</h2>
<li><a href="simulator.html#amaranth.sim.TriggerCombination.edge">(amaranth.sim.TriggerCombination method)</a>
</li>
</ul></li>
<li><a href="stdlib/coding.html#amaranth.lib.coding.Encoder">Encoder (class in amaranth.lib.coding)</a>
</li>
<li><a href="stdlib/enum.html#amaranth.lib.enum.Enum">Enum (class in amaranth.lib.enum)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="stdlib/enum.html#amaranth.lib.enum.EnumType">EnumType (class in amaranth.lib.enum)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="stdlib/enum.html#amaranth.lib.enum.EnumView">EnumView (class in amaranth.lib.enum)</a>
</li>
<li><a href="reference.html#amaranth.hdl.Value.eq">eq() (amaranth.hdl.Value method)</a>
Expand Down Expand Up @@ -995,14 +984,10 @@ <h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="simulator.html#amaranth.sim.SimulatorContext.get">get() (amaranth.sim.SimulatorContext method)</a>
</li>
<li><a href="platform/gowin.html#amaranth.vendor.GowinPlatform">GowinPlatform (class in amaranth.vendor)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="stdlib/coding.html#amaranth.lib.coding.GrayDecoder">GrayDecoder (class in amaranth.lib.coding)</a>
</li>
<li><a href="stdlib/coding.html#amaranth.lib.coding.GrayEncoder">GrayEncoder (class in amaranth.lib.coding)</a>
<li><a href="platform/gowin.html#amaranth.vendor.GowinPlatform">GowinPlatform (class in amaranth.vendor)</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -1079,8 +1064,6 @@ <h2 id="M">M</h2>
<li><a href="reference.html#module-amaranth.hdl">amaranth.hdl</a>
</li>
<li><a href="stdlib/cdc.html#module-amaranth.lib.cdc">amaranth.lib.cdc</a>
</li>
<li><a href="stdlib/coding.html#module-amaranth.lib.coding">amaranth.lib.coding</a>
</li>
<li><a href="stdlib/crc.html#module-amaranth.lib.crc">amaranth.lib.crc</a>
</li>
Expand Down Expand Up @@ -1159,10 +1142,6 @@ <h2 id="P">P</h2>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="stdlib/coding.html#amaranth.lib.coding.PriorityDecoder">PriorityDecoder (class in amaranth.lib.coding)</a>
</li>
<li><a href="stdlib/coding.html#amaranth.lib.coding.PriorityEncoder">PriorityEncoder (class in amaranth.lib.coding)</a>
</li>
<li><a href="stdlib/crc.html#amaranth.lib.crc.Processor">Processor (class in amaranth.lib.crc)</a>
</li>
<li><a href="stdlib/cdc.html#amaranth.lib.cdc.PulseSynchronizer">PulseSynchronizer (class in amaranth.lib.cdc)</a>
Expand Down
6 changes: 3 additions & 3 deletions docs/amaranth/latest/guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Language guide &mdash; Amaranth language &amp; toolchain 0.5.0.dev1 documentation</title>
<title>Language guide &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
Expand All @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8f0cda3f"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/platformpicker.js"></script>
Expand All @@ -41,7 +41,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.5.0.dev1
0.6.0.dev1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
8 changes: 4 additions & 4 deletions docs/amaranth/latest/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Language &amp; toolchain &mdash; Amaranth language &amp; toolchain 0.5.0.dev1 documentation</title>
<title>Language &amp; toolchain &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
Expand All @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8f0cda3f"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/platformpicker.js"></script>
Expand All @@ -41,7 +41,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.5.0.dev1
0.6.0.dev1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -167,7 +167,6 @@ <h1>Language &amp; toolchain<a class="headerlink" href="#language-toolchain" tit
<li class="toctree-l2"><a class="reference internal" href="stdlib/memory.html">Memory arrays</a></li>
<li class="toctree-l2"><a class="reference internal" href="stdlib/io.html">Input/output buffers</a></li>
<li class="toctree-l2"><a class="reference internal" href="stdlib/cdc.html">Clock domain crossing</a></li>
<li class="toctree-l2"><a class="reference internal" href="stdlib/coding.html">Code conversion</a></li>
<li class="toctree-l2"><a class="reference internal" href="stdlib/fifo.html">First-in first-out queues</a></li>
<li class="toctree-l2"><a class="reference internal" href="stdlib/crc.html">Cyclic redundancy checks</a></li>
</ul>
Expand All @@ -189,6 +188,7 @@ <h1>Language &amp; toolchain<a class="headerlink" href="#language-toolchain" tit
</li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changes.html#documentation-for-past-releases">Documentation for past releases</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#version-0-6-unreleased">Version 0.6 (unreleased)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#version-0-5">Version 0.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#version-0-4">Version 0.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#version-0-3">Version 0.3</a></li>
Expand Down
6 changes: 3 additions & 3 deletions docs/amaranth/latest/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installation &mdash; Amaranth language &amp; toolchain 0.5.0.dev1 documentation</title>
<title>Installation &mdash; Amaranth language &amp; toolchain 0.6.0.dev1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
Expand All @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8f0cda3f"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=0a5925ae"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/platformpicker.js"></script>
Expand All @@ -41,7 +41,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.5.0.dev1
0.6.0.dev1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Loading

0 comments on commit 47dea6f

Please sign in to comment.