Skip to content

Commit

Permalink
Deploying to main from @ amaranth-lang/amaranth@b30c87f 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Feb 15, 2024
1 parent d4b15cb commit 40d495f
Show file tree
Hide file tree
Showing 46 changed files with 138 additions and 126 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: 7a89de9fe053ed9ab8cc892fbb11a395
config: 74661362056e2492c05cc0a40809357d
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/amaranth/latest/.doctrees/contrib.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/install.doctree
Binary file not shown.
Binary file modified docs/amaranth/latest/.doctrees/intro.doctree
Binary file not shown.
Binary file modified docs/amaranth/latest/.doctrees/stdlib/crc.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions docs/amaranth/latest/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
_build/
_linkcheck/
10 changes: 5 additions & 5 deletions docs/amaranth/latest/_sources/contrib.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Filing problem reports

We would like Amaranth to be a best-in-class design tool, and hearing about issues people encounter while using it is crucial for improving it. While we do care a lot about correctness of the results, we care about the experience of using the tool just as much. Amaranth is meant to be a tool that is comfortable to use: with fewer sharp edges (no matter how much technological appeal they might have) and more signs and guardrails.

Please `report <issues>`_ any problems you encounter using Amaranth. To go beyond that: **If, while you are using Amaranth, you see an error message that is hard to understand or is misleading, please report it as a bug. Even (especially!) if you think you did something wrong.**
Please `report <issues_>`_ any problems you encounter using Amaranth. To go beyond that: **If, while you are using Amaranth, you see an error message that is hard to understand or is misleading, please report it as a bug. Even (especially!) if you think you did something wrong.**

.. _issues: https://github.com/amaranth-lang/amaranth
.. _issues: https://github.com/amaranth-lang/amaranth/issues

When filing problem reports, please include the following information:

Expand All @@ -34,7 +34,7 @@ Proposing new features

Amaranth is a programming language and a toolchain, which is different from many other kinds of open source projects in that just about every part of it is, unavoidably, tightly coupled to every other one, the result being that seemingly obvious and apparently minor decisions can have dramatic consequences years later.

To make sure that new features undergo the scrutiny necessary for commitment to many years of support, and to make sure that everyone in the community who will be impacted by the changes has a chance to make their voice heard, **all substantial changes, including feature proposals, must go through a formal Request for Comments process**. The process, as well as the accepted proposals, are described `here <rfcs>`_. Typically, substantial changes are accepted after one to several rounds of community review achieve near-unanimous consensus.
To make sure that new features undergo the scrutiny necessary for commitment to many years of support, and to make sure that everyone in the community who will be impacted by the changes has a chance to make their voice heard, **all substantial changes, including feature proposals, must go through a formal Request for Comments process**. The process, as well as the accepted proposals, are described `here <rfcs_>`_. Typically, substantial changes are accepted after one to several rounds of community review achieve near-unanimous consensus.

.. _rfcs: https://amaranth-lang.org/rfcs/

Expand All @@ -48,8 +48,8 @@ Preparing the environment

The Amaranth codebase uses the PDM_ package and dependency manager to structure the development workflow. Please `install PDM`_ first and make sure you have downloaded the latest changes to the source files. Once you have done so, run:

.. _PDM: https://pdm.fming.dev/
.. _install PDM: https://pdm.fming.dev/latest/#recommended-installation-method
.. _PDM: https://pdm-project.org/
.. _install PDM: https://pdm-project.org/latest/#recommended-installation-method

.. code-block:: console
Expand Down
6 changes: 3 additions & 3 deletions docs/amaranth/latest/_sources/install.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Synthesizing, placing and routing an Amaranth design for an FPGA requires the FP
.. _CPython: https://www.python.org/
.. _PyPy3.8: https://www.pypy.org/
.. _pip: https://pip.pypa.io/
.. _pip: https://pip.pypa.io/en/stable/
.. _Yosys: https://yosyshq.net/yosys/
.. _PyPI: https://pypi.org/
.. _GTKWave: http://gtkwave.sourceforge.net/
.. _GTKWave: https://gtkwave.sourceforge.net/


.. _install-deps:
Expand Down Expand Up @@ -109,7 +109,7 @@ Installing prerequisites

If Yosys |yosys-version| is not available, `build Yosys from source`_.

.. _build Yosys from source: https://github.com/YosysHQ/yosys/#setup
.. _build Yosys from source: https://github.com/YosysHQ/yosys/#building-from-source

|upgrade-pip|

Expand Down
4 changes: 2 additions & 2 deletions docs/amaranth/latest/_sources/intro.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ The Amaranth simulator is event-driven and can simulate designs with multiple cl

Although Amaranth does not support native code simulation or co-simulation at the moment, such support will be added in near future.

.. _Icarus Verilog: http://iverilog.icarus.com/
.. _Verilator: https://www.veripool.org/wiki/verilator
.. _Icarus Verilog: https://steveicarus.github.io/iverilog/
.. _Verilator: https://www.veripool.org/verilator/
.. _GTKWave: http://gtkwave.sourceforge.net/
.. _PyPy: https://www.pypy.org/

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.dev106',
VERSION: '0.4.1.dev108',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
6 changes: 3 additions & 3 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.dev106 documentation</title>
<title>Changelog &mdash; Amaranth language &amp; toolchain 0.4.1.dev108 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=c962c943"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8500ee98"></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.dev106+ge3324e1
0.4.1.dev108+gb30c87f
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
11 changes: 11 additions & 0 deletions docs/amaranth/latest/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,14 @@
.. role:: py(code)
:language: python
"""

linkcheck_ignore = [
r"^http://127\.0\.0\.1:8000$"
]

linkcheck_anchors_ignore_for_url = [
r"^https://matrix\.to/",
r"^https://web\.libera\.chat/",
# React page with README content included as a JSON payload.
r"^https://github\.com/[^/]+/[^/]+/$",
]
12 changes: 6 additions & 6 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.dev106 documentation</title>
<title>Contributing &mdash; Amaranth language &amp; toolchain 0.4.1.dev108 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=c962c943"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8500ee98"></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.dev106+ge3324e1
0.4.1.dev108+gb30c87f
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -110,7 +110,7 @@ <h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to t
<section id="filing-problem-reports">
<h2>Filing problem reports<a class="headerlink" href="#filing-problem-reports" title="Permalink to this heading"></a></h2>
<p>We would like Amaranth to be a best-in-class design tool, and hearing about issues people encounter while using it is crucial for improving it. While we do care a lot about correctness of the results, we care about the experience of using the tool just as much. Amaranth is meant to be a tool that is comfortable to use: with fewer sharp edges (no matter how much technological appeal they might have) and more signs and guardrails.</p>
<p>Please <a class="reference external" href="issues">report</a> any problems you encounter using Amaranth. To go beyond that: <strong>If, while you are using Amaranth, you see an error message that is hard to understand or is misleading, please report it as a bug. Even (especially!) if you think you did something wrong.</strong></p>
<p>Please <a class="reference external" href="https://github.com/amaranth-lang/amaranth/issues">report</a> any problems you encounter using Amaranth. To go beyond that: <strong>If, while you are using Amaranth, you see an error message that is hard to understand or is misleading, please report it as a bug. Even (especially!) if you think you did something wrong.</strong></p>
<p>When filing problem reports, please include the following information:</p>
<ul class="simple">
<li><p>The exact version of Amaranth, which you can find by running <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-c</span> <span class="pre">&quot;import</span> <span class="pre">amaranth;</span> <span class="pre">print(amaranth.__version__)&quot;</span></code>;</p></li>
Expand All @@ -127,13 +127,13 @@ <h2>Fixing problems<a class="headerlink" href="#fixing-problems" title="Permalin
<section id="proposing-new-features">
<h2>Proposing new features<a class="headerlink" href="#proposing-new-features" title="Permalink to this heading"></a></h2>
<p>Amaranth is a programming language and a toolchain, which is different from many other kinds of open source projects in that just about every part of it is, unavoidably, tightly coupled to every other one, the result being that seemingly obvious and apparently minor decisions can have dramatic consequences years later.</p>
<p>To make sure that new features undergo the scrutiny necessary for commitment to many years of support, and to make sure that everyone in the community who will be impacted by the changes has a chance to make their voice heard, <strong>all substantial changes, including feature proposals, must go through a formal Request for Comments process</strong>. The process, as well as the accepted proposals, are described <a class="reference external" href="rfcs">here</a>. Typically, substantial changes are accepted after one to several rounds of community review achieve near-unanimous consensus.</p>
<p>To make sure that new features undergo the scrutiny necessary for commitment to many years of support, and to make sure that everyone in the community who will be impacted by the changes has a chance to make their voice heard, <strong>all substantial changes, including feature proposals, must go through a formal Request for Comments process</strong>. The process, as well as the accepted proposals, are described <a class="reference external" href="https://amaranth-lang.org/rfcs/">here</a>. Typically, substantial changes are accepted after one to several rounds of community review achieve near-unanimous consensus.</p>
</section>
<section id="working-with-the-codebase">
<h2>Working with the codebase<a class="headerlink" href="#working-with-the-codebase" title="Permalink to this heading"></a></h2>
<section id="preparing-the-environment">
<h3>Preparing the environment<a class="headerlink" href="#preparing-the-environment" title="Permalink to this heading"></a></h3>
<p>The Amaranth codebase uses the <a class="reference external" href="https://pdm.fming.dev/">PDM</a> package and dependency manager to structure the development workflow. Please <a class="reference external" href="https://pdm.fming.dev/latest/#recommended-installation-method">install PDM</a> first and make sure you have downloaded the latest changes to the source files. Once you have done so, run:</p>
<p>The Amaranth codebase uses the <a class="reference external" href="https://pdm-project.org/">PDM</a> package and dependency manager to structure the development workflow. Please <a class="reference external" href="https://pdm-project.org/latest/#recommended-installation-method">install PDM</a> first and make sure you have downloaded the latest changes to the source files. Once you have done so, run:</p>
<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>
Expand Down
10 changes: 5 additions & 5 deletions docs/amaranth/latest/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Filing problem reports

We would like Amaranth to be a best-in-class design tool, and hearing about issues people encounter while using it is crucial for improving it. While we do care a lot about correctness of the results, we care about the experience of using the tool just as much. Amaranth is meant to be a tool that is comfortable to use: with fewer sharp edges (no matter how much technological appeal they might have) and more signs and guardrails.

Please `report <issues>`_ any problems you encounter using Amaranth. To go beyond that: **If, while you are using Amaranth, you see an error message that is hard to understand or is misleading, please report it as a bug. Even (especially!) if you think you did something wrong.**
Please `report <issues_>`_ any problems you encounter using Amaranth. To go beyond that: **If, while you are using Amaranth, you see an error message that is hard to understand or is misleading, please report it as a bug. Even (especially!) if you think you did something wrong.**

.. _issues: https://github.com/amaranth-lang/amaranth
.. _issues: https://github.com/amaranth-lang/amaranth/issues

When filing problem reports, please include the following information:

Expand All @@ -34,7 +34,7 @@ Proposing new features

Amaranth is a programming language and a toolchain, which is different from many other kinds of open source projects in that just about every part of it is, unavoidably, tightly coupled to every other one, the result being that seemingly obvious and apparently minor decisions can have dramatic consequences years later.

To make sure that new features undergo the scrutiny necessary for commitment to many years of support, and to make sure that everyone in the community who will be impacted by the changes has a chance to make their voice heard, **all substantial changes, including feature proposals, must go through a formal Request for Comments process**. The process, as well as the accepted proposals, are described `here <rfcs>`_. Typically, substantial changes are accepted after one to several rounds of community review achieve near-unanimous consensus.
To make sure that new features undergo the scrutiny necessary for commitment to many years of support, and to make sure that everyone in the community who will be impacted by the changes has a chance to make their voice heard, **all substantial changes, including feature proposals, must go through a formal Request for Comments process**. The process, as well as the accepted proposals, are described `here <rfcs_>`_. Typically, substantial changes are accepted after one to several rounds of community review achieve near-unanimous consensus.

.. _rfcs: https://amaranth-lang.org/rfcs/

Expand All @@ -48,8 +48,8 @@ Preparing the environment

The Amaranth codebase uses the PDM_ package and dependency manager to structure the development workflow. Please `install PDM`_ first and make sure you have downloaded the latest changes to the source files. Once you have done so, run:

.. _PDM: https://pdm.fming.dev/
.. _install PDM: https://pdm.fming.dev/latest/#recommended-installation-method
.. _PDM: https://pdm-project.org/
.. _install PDM: https://pdm-project.org/latest/#recommended-installation-method

.. code-block:: console
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.dev106 documentation</title>
<title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.4.1.dev108 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=c962c943"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8500ee98"></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.dev106+ge3324e1
0.4.1.dev108+gb30c87f
</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.dev106 documentation</title>
<title>Index &mdash; Amaranth language &amp; toolchain 0.4.1.dev108 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=c962c943"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8500ee98"></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.dev106+ge3324e1
0.4.1.dev108+gb30c87f
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Loading

0 comments on commit 40d495f

Please sign in to comment.