Skip to content

Commit

Permalink
Deploying to main from @ amaranth-lang/amaranth@8501d9d 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Jan 29, 2024
1 parent d0d341f commit 35b8098
Show file tree
Hide file tree
Showing 37 changed files with 130 additions and 99 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: 0174babccb0e81e02fc0fd071022581c
config: 62c0a780a29725e3430b9a15917be9ec
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.
16 changes: 13 additions & 3 deletions docs/amaranth/latest/_sources/changes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ Changelog
This document describes changes to the public interfaces in the Amaranth language and standard library. It does not include most bug fixes or implementation changes.


Documentation for past releases
===============================

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

* `Amaranth 0.4.1 <https://amaranth-lang.org/docs/amaranth/v0.4.1/>`_
* `Amaranth 0.4.0 <https://amaranth-lang.org/docs/amaranth/v0.4.0/>`_
* `Amaranth 0.3 <https://amaranth-lang.org/docs/amaranth/v0.3/>`_


Version 0.5 (unreleased)
========================

Expand All @@ -17,8 +27,8 @@ Apply the following changes to code written against Amaranth 0.4 to migrate it t

* Replace uses of ``m.Case()`` with no patterns with ``m.Default()``
* Replace uses of ``Value.matches()`` with no patterns with ``Const(1)``
* Update uses of :func:`amaranth.utils.log2_int(need_pow2=False)` to :func:`amaranth.utils.ceil_log2`
* Update uses of :func:`amaranth.utils.log2_int(need_pow2=True)` to :func:`amaranth.utils.exact_log2`
* Update uses of ``amaranth.utils.log2_int(need_pow2=False)`` to :func:`amaranth.utils.ceil_log2`
* Update uses of ``amaranth.utils.log2_int(need_pow2=True)`` to :func:`amaranth.utils.exact_log2`


Implemented RFCs
Expand Down Expand Up @@ -63,7 +73,7 @@ Platform integration changes
* Added: :meth:`BuildPlan.execute_local_docker`.
* Added: :meth:`BuildPlan.extract`.
* Added: ``build.sh`` begins with ``#!/bin/sh``.
* Deprecated: argument `run_script=` in :meth:`BuildPlan.execute_local`
* Deprecated: argument ``run_script=`` in :meth:`BuildPlan.execute_local`.
* Removed: (deprecated in 0.4) :mod:`vendor.intel`, :mod:`vendor.lattice_ecp5`, :mod:`vendor.lattice_ice40`, :mod:`vendor.lattice_machxo2_3l`, :mod:`vendor.quicklogic`, :mod:`vendor.xilinx`. (`RFC 18`_)


Expand Down
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.4.1.dev46',
VERSION: '0.4.1.dev48',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
22 changes: 16 additions & 6 deletions docs/amaranth/latest/changes.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Changelog &mdash; Amaranth language &amp; toolchain 0.4.1.dev46 documentation</title>
<title>Changelog &mdash; Amaranth language &amp; toolchain 0.4.1.dev48 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/platformpicker.css" type="text/css" />
Expand All @@ -15,7 +15,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=e39980ae"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=affba775"></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 @@ -39,7 +39,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.4.1.dev46+g65d77f0
0.4.1.dev48+g8501d9d
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand All @@ -59,6 +59,7 @@
<li class="toctree-l2"><a class="reference internal" href="stdlib.html">Standard library</a></li>
<li class="toctree-l2"><a class="reference internal" href="platform.html">Platform integration</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#documentation-for-past-releases">Documentation for past releases</a></li>
<li class="toctree-l3"><a class="reference internal" href="#version-0-5-unreleased">Version 0.5 (unreleased)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#migrating-from-version-0-4">Migrating from version 0.4</a></li>
<li class="toctree-l4"><a class="reference internal" href="#implemented-rfcs">Implemented RFCs</a></li>
Expand Down Expand Up @@ -122,6 +123,15 @@
<section id="changelog">
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this heading"></a></h1>
<p>This document describes changes to the public interfaces in the Amaranth language and standard library. It does not include most bug fixes or implementation changes.</p>
<section id="documentation-for-past-releases">
<h2>Documentation for past releases<a class="headerlink" href="#documentation-for-past-releases" title="Permalink to this heading"></a></h2>
<p>Documentation for past releases of the Amaranth language and toolchain is available online:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://amaranth-lang.org/docs/amaranth/v0.4.1/">Amaranth 0.4.1</a></p></li>
<li><p><a class="reference external" href="https://amaranth-lang.org/docs/amaranth/v0.4.0/">Amaranth 0.4.0</a></p></li>
<li><p><a class="reference external" href="https://amaranth-lang.org/docs/amaranth/v0.3/">Amaranth 0.3</a></p></li>
</ul>
</section>
<section id="version-0-5-unreleased">
<h2>Version 0.5 (unreleased)<a class="headerlink" href="#version-0-5-unreleased" title="Permalink to this heading"></a></h2>
<p>The Migen compatibility layer has been removed.</p>
Expand All @@ -131,8 +141,8 @@ <h3>Migrating from version 0.4<a class="headerlink" href="#migrating-from-versio
<ul class="simple">
<li><p>Replace uses of <code class="docutils literal notranslate"><span class="pre">m.Case()</span></code> with no patterns with <code class="docutils literal notranslate"><span class="pre">m.Default()</span></code></p></li>
<li><p>Replace uses of <code class="docutils literal notranslate"><span class="pre">Value.matches()</span></code> with no patterns with <code class="docutils literal notranslate"><span class="pre">Const(1)</span></code></p></li>
<li><p>Update uses of <code class="xref py py-func docutils literal notranslate"><span class="pre">amaranth.utils.log2_int(need_pow2=False)()</span></code> to <code class="xref py py-func docutils literal notranslate"><span class="pre">amaranth.utils.ceil_log2()</span></code></p></li>
<li><p>Update uses of <code class="xref py py-func docutils literal notranslate"><span class="pre">amaranth.utils.log2_int(need_pow2=True)()</span></code> to <code class="xref py py-func docutils literal notranslate"><span class="pre">amaranth.utils.exact_log2()</span></code></p></li>
<li><p>Update uses of <code class="docutils literal notranslate"><span class="pre">amaranth.utils.log2_int(need_pow2=False)</span></code> to <code class="xref py py-func docutils literal notranslate"><span class="pre">amaranth.utils.ceil_log2()</span></code></p></li>
<li><p>Update uses of <code class="docutils literal notranslate"><span class="pre">amaranth.utils.log2_int(need_pow2=True)</span></code> to <code class="xref py py-func docutils literal notranslate"><span class="pre">amaranth.utils.exact_log2()</span></code></p></li>
</ul>
</section>
<section id="implemented-rfcs">
Expand Down Expand Up @@ -168,7 +178,7 @@ <h3>Platform integration changes<a class="headerlink" href="#platform-integratio
<li><p>Added: <code class="xref py py-meth docutils literal notranslate"><span class="pre">BuildPlan.execute_local_docker()</span></code>.</p></li>
<li><p>Added: <code class="xref py py-meth docutils literal notranslate"><span class="pre">BuildPlan.extract()</span></code>.</p></li>
<li><p>Added: <code class="docutils literal notranslate"><span class="pre">build.sh</span></code> begins with <code class="docutils literal notranslate"><span class="pre">#!/bin/sh</span></code>.</p></li>
<li><p>Deprecated: argument <cite>run_script=</cite> in <code class="xref py py-meth docutils literal notranslate"><span class="pre">BuildPlan.execute_local()</span></code></p></li>
<li><p>Deprecated: argument <code class="docutils literal notranslate"><span class="pre">run_script=</span></code> in <code class="xref py py-meth docutils literal notranslate"><span class="pre">BuildPlan.execute_local()</span></code>.</p></li>
<li><p>Removed: (deprecated in 0.4) <code class="xref py py-mod docutils literal notranslate"><span class="pre">vendor.intel</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">vendor.lattice_ecp5</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">vendor.lattice_ice40</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">vendor.lattice_machxo2_3l</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">vendor.quicklogic</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">vendor.xilinx</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0018-reorganize-vendor-platforms.html">RFC 18</a>)</p></li>
</ul>
</section>
Expand Down
16 changes: 13 additions & 3 deletions docs/amaranth/latest/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ Changelog
This document describes changes to the public interfaces in the Amaranth language and standard library. It does not include most bug fixes or implementation changes.


Documentation for past releases
===============================

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

* `Amaranth 0.4.1 <https://amaranth-lang.org/docs/amaranth/v0.4.1/>`_
* `Amaranth 0.4.0 <https://amaranth-lang.org/docs/amaranth/v0.4.0/>`_
* `Amaranth 0.3 <https://amaranth-lang.org/docs/amaranth/v0.3/>`_


Version 0.5 (unreleased)
========================

Expand All @@ -17,8 +27,8 @@ Apply the following changes to code written against Amaranth 0.4 to migrate it t

* Replace uses of ``m.Case()`` with no patterns with ``m.Default()``
* Replace uses of ``Value.matches()`` with no patterns with ``Const(1)``
* Update uses of :func:`amaranth.utils.log2_int(need_pow2=False)` to :func:`amaranth.utils.ceil_log2`
* Update uses of :func:`amaranth.utils.log2_int(need_pow2=True)` to :func:`amaranth.utils.exact_log2`
* Update uses of ``amaranth.utils.log2_int(need_pow2=False)`` to :func:`amaranth.utils.ceil_log2`
* Update uses of ``amaranth.utils.log2_int(need_pow2=True)`` to :func:`amaranth.utils.exact_log2`


Implemented RFCs
Expand Down Expand Up @@ -63,7 +73,7 @@ Platform integration changes
* Added: :meth:`BuildPlan.execute_local_docker`.
* Added: :meth:`BuildPlan.extract`.
* Added: ``build.sh`` begins with ``#!/bin/sh``.
* Deprecated: argument `run_script=` in :meth:`BuildPlan.execute_local`
* Deprecated: argument ``run_script=`` in :meth:`BuildPlan.execute_local`.
* Removed: (deprecated in 0.4) :mod:`vendor.intel`, :mod:`vendor.lattice_ecp5`, :mod:`vendor.lattice_ice40`, :mod:`vendor.lattice_machxo2_3l`, :mod:`vendor.quicklogic`, :mod:`vendor.xilinx`. (`RFC 18`_)


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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing &mdash; Amaranth language &amp; toolchain 0.4.1.dev46 documentation</title>
<title>Contributing &mdash; Amaranth language &amp; toolchain 0.4.1.dev48 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/platformpicker.css" type="text/css" />
Expand All @@ -15,7 +15,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=e39980ae"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=affba775"></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.4.1.dev46+g65d77f0
0.4.1.dev48+g8501d9d
</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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.4.1.dev46 documentation</title>
<title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.4.1.dev48 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/platformpicker.css" type="text/css" />
Expand All @@ -15,7 +15,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=e39980ae"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=affba775"></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.4.1.dev46+g65d77f0
0.4.1.dev48+g8501d9d
</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/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.4.1.dev46 documentation</title>
<title>Index &mdash; Amaranth language &amp; toolchain 0.4.1.dev48 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/platformpicker.css" type="text/css" />
Expand All @@ -14,7 +14,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=e39980ae"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=affba775"></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 @@ -36,7 +36,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.4.1.dev46+g65d77f0
0.4.1.dev48+g8501d9d
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
7 changes: 4 additions & 3 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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Language &amp; toolchain &mdash; Amaranth language &amp; toolchain 0.4.1.dev46 documentation</title>
<title>Language &amp; toolchain &mdash; Amaranth language &amp; toolchain 0.4.1.dev48 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/platformpicker.css" type="text/css" />
Expand All @@ -15,7 +15,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=e39980ae"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=affba775"></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 @@ -39,7 +39,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.4.1.dev46+g65d77f0
0.4.1.dev48+g8501d9d
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -162,6 +162,7 @@ <h1>Language &amp; toolchain<a class="headerlink" href="#language-toolchain" tit
</ul>
</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-5-unreleased">Version 0.5 (unreleased)</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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installation &mdash; Amaranth language &amp; toolchain 0.4.1.dev46 documentation</title>
<title>Installation &mdash; Amaranth language &amp; toolchain 0.4.1.dev48 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/platformpicker.css" type="text/css" />
Expand All @@ -15,7 +15,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=e39980ae"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=affba775"></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 @@ -39,7 +39,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.4.1.dev46+g65d77f0
0.4.1.dev48+g8501d9d
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Loading

0 comments on commit 35b8098

Please sign in to comment.