Skip to content

Commit

Permalink
Deploying to main from @ amaranth-lang/amaranth@cce4e44 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Oct 5, 2023
1 parent 87e0e51 commit dd7f637
Show file tree
Hide file tree
Showing 32 changed files with 169 additions and 169 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: 1359bc177102d47bc0afe08f67c27f04
config: e7d589590ce9365be8c367ebfb42d51e
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/amaranth/latest/.doctrees/environment.pickle
Binary file not shown.
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.dev211',
VERSION: '0.4.dev212',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
10 changes: 5 additions & 5 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 HDL toolchain 0.4.dev211 documentation</title>
<title>Changelog &mdash; Amaranth HDL toolchain 0.4.dev212 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 Down Expand Up @@ -39,7 +39,7 @@
Amaranth HDL toolchain
</a>
<div class="version">
0.4.dev211+gc941667.editable
0.4.dev212+gcce4e44.editable
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -165,7 +165,7 @@ <h3>Language changes<a class="headerlink" href="#language-changes" title="Permal
<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>
<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 <code class="xref py py-class docutils literal notranslate"><span class="pre">ShapeCastable</span></code> implementing <code class="xref py py-meth docutils literal notranslate"><span class="pre">ShapeCastable.__call__()</span></code> 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>
<li><p>Changed: <code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.cast()</span></code> casts <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueCastable</span></code> objects recursively.</p></li>
<li><p>Changed: <code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.cast()</span></code> 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.11)"><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.11)"><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.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.IntEnum</span></code></a>) as enumerations rather than integers.</p></li>
<li><p>Changed: <code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.cast()</span></code> 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>
<li><p>Changed: <code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.matches()</span></code> 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>
<li><p>Changed: <code class="xref py py-class 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>
<li><p>Deprecated: <code class="xref py py-meth docutils literal notranslate"><span class="pre">Const.normalize()</span></code>; use <code class="docutils literal notranslate"><span class="pre">Const(value,</span> <span class="pre">shape).value</span></code> instead of <code class="docutils literal notranslate"><span class="pre">Const.normalize(value,</span> <span class="pre">shape)</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0005-remove-const-normalize.html">RFC 5</a>)</p></li>
Expand Down Expand Up @@ -195,7 +195,7 @@ <h3>Toolchain changes<a class="headerlink" href="#toolchain-changes" title="Perm
<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>
<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>
<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>
<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.11)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">test</span></code></a>.</p></li>
<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>
</ul>
</section>
<section id="platform-integration-changes">
Expand Down Expand Up @@ -235,7 +235,7 @@ <h3>Migrating from version 0.2<a class="headerlink" href="#migrating-from-versio
<section id="id1">
<h3>Language changes<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Added: <code class="xref py py-class docutils literal notranslate"><span class="pre">Value</span></code> can be used with <a class="reference external" href="https://docs.python.org/3/library/functions.html#abs" title="(in Python v3.11)"><code class="xref py py-func docutils literal notranslate"><span class="pre">abs()</span></code></a>.</p></li>
<li><p>Added: <code class="xref py py-class docutils literal notranslate"><span class="pre">Value</span></code> 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>
<li><p>Added: <code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.rotate_left()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.rotate_right()</span></code>.</p></li>
<li><p>Added: <code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.shift_left()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.shift_right()</span></code>.</p></li>
<li><p>Added: <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueCastable</span></code>.</p></li>
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 HDL toolchain 0.4.dev211 documentation</title>
<title>Contributing &mdash; Amaranth HDL toolchain 0.4.dev212 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 Down Expand Up @@ -38,7 +38,7 @@
Amaranth HDL toolchain
</a>
<div class="version">
0.4.dev211+gc941667.editable
0.4.dev212+gcce4e44.editable
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -135,7 +135,7 @@ <h3>Preparing the environment<a class="headerlink" href="#preparing-the-environm
<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
</pre></div>
</div>
<p>This command creates a <a class="reference external" href="https://docs.python.org/3/tutorial/venv.html#tut-venv" title="(in Python v3.11)"><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>
<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>
<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>
</section>
<section id="running-the-testsuite">
Expand Down
4 changes: 2 additions & 2 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 HDL documentation &mdash; Amaranth HDL toolchain 0.4.dev211 documentation</title>
<title>Amaranth HDL documentation &mdash; Amaranth HDL toolchain 0.4.dev212 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 Down Expand Up @@ -38,7 +38,7 @@
Amaranth HDL toolchain
</a>
<div class="version">
0.4.dev211+gc941667.editable
0.4.dev212+gcce4e44.editable
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
4 changes: 2 additions & 2 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 HDL toolchain 0.4.dev211 documentation</title>
<title>Index &mdash; Amaranth HDL toolchain 0.4.dev212 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 Down Expand Up @@ -36,7 +36,7 @@
Amaranth HDL toolchain
</a>
<div class="version">
0.4.dev211+gc941667.editable
0.4.dev212+gcce4e44.editable
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
4 changes: 2 additions & 2 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 HDL toolchain 0.4.dev211 documentation</title>
<title>Language &amp; toolchain &mdash; Amaranth HDL toolchain 0.4.dev212 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 Down Expand Up @@ -39,7 +39,7 @@
Amaranth HDL toolchain
</a>
<div class="version">
0.4.dev211+gc941667.editable
0.4.dev212+gcce4e44.editable
</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/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 HDL toolchain 0.4.dev211 documentation</title>
<title>Installation &mdash; Amaranth HDL toolchain 0.4.dev212 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 Down Expand Up @@ -39,7 +39,7 @@
Amaranth HDL toolchain
</a>
<div class="version">
0.4.dev211+gc941667.editable
0.4.dev212+gcce4e44.editable
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -115,7 +115,7 @@ <h2>System requirements<a class="headerlink" href="#system-requirements" title="
<div class="platform-picker docutils container">
<div class="platform-choice platform--windows platform-noaltname docutils container">
<p class="platform-title">Windows</p>
<p><a class="reference external" href="https://docs.python.org/3/using/windows.html#using-on-windows" title="(in Python v3.11)"><span class="xref std std-ref">Install Python</span></a>, either from Windows Store or using the full installer. If using the full installer, make sure to install a 64-bit version of Python.</p>
<p><a class="reference external" href="https://docs.python.org/3/using/windows.html#using-on-windows" title="(in Python v3.12)"><span class="xref std std-ref">Install Python</span></a>, either from Windows Store or using the full installer. If using the full installer, make sure to install a 64-bit version of Python.</p>
<p><a class="reference external" href="https://sourceforge.net/projects/gtkwave/files/">Download GTKWave</a>, either win32 or win64 binaries. GTKWave does not need to be installed; it can be unpacked to any convenient location and run from there.</p>
<p>Before continuing, make sure you have the latest version of <a class="reference external" href="https://pip.pypa.io/">pip</a> installed by running:</p>
<div class="highlight-doscon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;</span> pip install --upgrade pip
Expand Down
4 changes: 2 additions & 2 deletions docs/amaranth/latest/intro.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>Introduction &mdash; Amaranth HDL toolchain 0.4.dev211 documentation</title>
<title>Introduction &mdash; Amaranth HDL toolchain 0.4.dev212 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 Down Expand Up @@ -39,7 +39,7 @@
Amaranth HDL toolchain
</a>
<div class="version">
0.4.dev211+gc941667.editable
0.4.dev212+gcce4e44.editable
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Loading

0 comments on commit dd7f637

Please sign in to comment.