Skip to content

Commit

Permalink
Deploying to main from @ amaranth-lang/amaranth@6fb5f3f 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Apr 7, 2024
1 parent 06a2de9 commit 91221c3
Show file tree
Hide file tree
Showing 43 changed files with 216 additions and 227 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: 4076b18fd408fa5510f14ff1673098af
config: f93bf0f1860341e37c2fd56db2b980ea
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/amaranth/latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/amaranth/latest/.doctrees/stdlib/memory.doctree
Binary file not shown.
41 changes: 0 additions & 41 deletions docs/amaranth/latest/_images/example_fifo.svg

This file was deleted.

22 changes: 0 additions & 22 deletions docs/amaranth/latest/_images/example_hello.svg

This file was deleted.

59 changes: 57 additions & 2 deletions docs/amaranth/latest/_sources/stdlib/memory.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,25 @@ In the following example, a read-only memory is used to output a fixed message i

In this example, the memory read port is asynchronous, and a change of the address input (labelled `a` on the diagram below) results in an immediate change of the data output (labelled `d`).

.. image:: _images/memory/example_hello.svg
.. wavedrom:: memory/example_hello

{
"signal": [
{"name": "clk",
"wave": "0P............"},
{"name": "rd_port.addr",
"wave": "==============",
"data": [0,1,2,3,4,5,6,7,8,9,10,11,0,1],
"node": ".a"},
{"name": "rd_port.data",
"wave": "==============",
"data": ["H","e","l","l","o"," ","w","o","r","l","d","\\n","H","e"],
"node": ".d"}
],
"edge": [
"a-|d"
]
}

First-in, first-out queue
Expand Down Expand Up @@ -112,7 +130,44 @@ In this example, the memory read and write ports are synchronous. A write operat

However, the memory read port is also configured to be *transparent* relative to the memory write port. This means that if a write and a read operation (labelled `t`, `u` respectively) access the same row with address 3, the new contents will be read out, reducing the minimum push-to-pop latency to one cycle, down from two cycles that would be required without the use of transparency.

.. image:: _images/memory/example_fifo.svg
.. wavedrom:: memory/example_fifo

{
"signal": [
{"name": "clk",
"wave": "P........"},
{"name": "push",
"wave": "01..0.10.",
"node": ".x"},
{"name": "wr_port.addr",
"wave": "=.===..=.",
"data": ["0", "1", "2", "3", "4", "5"]},
{"name": "wr_port.data",
"wave": "====..=..",
"data": ["00", "AA", "BB", "CC", "DD"],
"node": ".w....t"},
{"name": "memory[0]",
"wave": "=.=......",
"data": ["00", "AA"],
"node": "..G"},
{"name": "memory[3]",
"wave": "=......=.",
"data": ["00", "DD"],
"node": ".......H"},
{"name": "pop",
"wave": "0..1...0.",
"node": "...y"},
{"name": "rd_port.addr",
"wave": "=...====.",
"data": ["0", "1", "2", "3", "4", "5"]},
{"name": "rd_port.data",
"wave": "=...====.",
"data": ["00", "AA", "BB", "CC", "DD"],
"node": "....r..u"}
], "edge": [
"x-~>G", "w->G", "y-~>r", "t->H", "t->u"
]
}


Memories
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.5.0.dev225',
VERSION: '0.5.0.dev226',
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="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Changelog &mdash; Amaranth language &amp; toolchain 0.5.0.dev225 documentation</title>
<title>Changelog &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 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=53ae257b"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></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.dev225+g7936b87
0.5.0.dev226+g6fb5f3f
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
3 changes: 3 additions & 0 deletions docs/amaranth/latest/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"sphinx.ext.napoleon",
"sphinx_rtd_theme",
"sphinxcontrib.platformpicker",
"sphinxcontrib.yowasp_wavedrom",
]

with open(".gitignore") as f:
Expand Down Expand Up @@ -45,6 +46,8 @@
"Platform overrides"
]

yowasp_wavedrom_skin = "light"

html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
html_css_files = ["custom.css"]
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.dev225 documentation</title>
<title>Contributing &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 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=53ae257b"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></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.dev225+g7936b87
0.5.0.dev226+g6fb5f3f
</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.dev225 documentation</title>
<title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 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=53ae257b"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></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.dev225+g7936b87
0.5.0.dev226+g6fb5f3f
</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.5.0.dev225 documentation</title>
<title>Index &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 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=53ae257b"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></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.dev225+g7936b87
0.5.0.dev226+g6fb5f3f
</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/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.dev225 documentation</title>
<title>Language guide &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 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=53ae257b"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></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.dev225+g7936b87
0.5.0.dev226+g6fb5f3f
</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/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.dev225 documentation</title>
<title>Language &amp; toolchain &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 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=53ae257b"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></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.dev225+g7936b87
0.5.0.dev226+g6fb5f3f
</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="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.dev225 documentation</title>
<title>Installation &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 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=53ae257b"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></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.dev225+g7936b87
0.5.0.dev226+g6fb5f3f
</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/intro.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>Introduction &mdash; Amaranth language &amp; toolchain 0.5.0.dev225 documentation</title>
<title>Introduction &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 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=53ae257b"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></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.dev225+g7936b87
0.5.0.dev226+g6fb5f3f
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Binary file modified docs/amaranth/latest/objects.inv
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/amaranth/latest/platform.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>Platform integration &mdash; Amaranth language &amp; toolchain 0.5.0.dev225 documentation</title>
<title>Platform integration &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 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=53ae257b"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6456af11"></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.dev225+g7936b87
0.5.0.dev226+g6fb5f3f
</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/platform/altera.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>Altera &mdash; Amaranth language &amp; toolchain 0.5.0.dev225 documentation</title>
<title>Altera &mdash; Amaranth language &amp; toolchain 0.5.0.dev226 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=53ae257b"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=6456af11"></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.dev225+g7936b87
0.5.0.dev226+g6fb5f3f
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
Loading

0 comments on commit 91221c3

Please sign in to comment.