usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: remove all generated WaveDrom diagrams.

Browse source
This commit is contained in:
Catherine 2024-04-10 00:32:35 +00:00
parent 4f6b0f23c2
commit 1a962cc405
10 changed files with 93 additions and 117 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
amaranth/lib/data.py
View file

@ -267,7 +267,21 @@ class StructLayout(Layout):
For example, the following layout of a 16-bit value:
.. image:: _images/data/struct_layout.svg
.. wavedrom:: data/struct_layout
{
"reg": [
{"name": ".first", "bits": 3},
{"name": ".second", "bits": 7},
{"name": ".third", "bits": 6}
],
"config": {
"lanes": 1,
"compact": true,
"vflip": true,
"hspace": 650
}
}
can be described with:
@ -344,7 +358,23 @@ class UnionLayout(Layout):
For example, the following layout of a 7-bit value:
.. image:: _images/data/union_layout.svg
.. wavedrom:: data/union_layout
{
"reg": [
{"name": ".third", "bits": 6},
{"name": "", "bits": 1, "type": 1},
{"name": ".second", "bits": 7},
{"name": ".first", "bits": 3},
{"name": "", "bits": 4, "type": 1}
],
"config": {
"lanes": 3,
"compact": true,
"vflip": true,
"hspace": 289.4375
}
}
can be described with:
@ -419,7 +449,22 @@ class ArrayLayout(Layout):
For example, the following layout of a 16-bit value:
.. image:: _images/data/array_layout.svg
.. wavedrom:: data/array_layout
{
"reg": [
{"name": "[0]", "bits": 4},
{"name": "[1]", "bits": 4},
{"name": "[2]", "bits": 4},
{"name": "[3]", "bits": 4}
],
"config": {
"lanes": 1,
"compact": true,
"vflip": true,
"hspace": 650
}
}
can be described with:
@ -502,7 +547,28 @@ class FlexibleLayout(Layout):
For example, the following layout of a 16-bit value:
.. image:: _images/data/flexible_layout.svg
.. wavedrom:: data/flexible_layout
{
"reg": [
{"name": "", "bits": 14, "type": 1},
{"name": "[0]", "bits": 1},
{"name": "", "bits": 1, "type": 1},
{"name": "", "bits": 10, "type": 1},
{"name": ".third", "bits": 6},
{"name": ".second", "bits": 7},
{"name": "", "bits": 9, "type": 1},
{"name": "", "bits": 1, "type": 1},
{"name": ".first", "bits": 3},
{"name": "", "bits": 12, "type": 1}
],
"config": {
"lanes": 4,
"compact": true,
"vflip": true,
"hspace": 650
}
}
can be described with:

8
docs/_static/custom.css vendored
View file

@ -22,4 +22,10 @@ a { text-decoration: underline; }
.rst-content pre.literal-block, .rst-content div[class^="highlight"] pre, .rst-content .linenodiv pre { white-space: pre-wrap; }
/* Work around https://github.com/readthedocs/sphinx_rtd_theme/issues/1301 */
.py.property { display: block !important; }
.py.property { display: block !important; }
/* Work around images in docstrings being glued to the paragraph underneath */
.rst-content section dd>img { margin-bottom: 24px; }
/* No switchable color schemes */
img { color-scheme: light; }

2
docs/conf.py
View file

@ -46,8 +46,6 @@ napoleon_custom_sections = [
"Platform overrides"
]
yowasp_wavedrom_skin = "light"
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
html_css_files = ["custom.css"]

21
docs/stdlib/_images/data/array_layout.svg
View file

@ -1,21 +0,0 @@
<!--
Render the following with wavedrom-bitfield:
{
"reg": [
{"name": "[0]", "bits": 4},
{"name": "[1]", "bits": 4},
{"name": "[2]", "bits": 4},
{"name": "[3]", "bits": 4},
],
"config": {
"lanes": 1,
"compact": true,
"vflip": true,
"hspace": 650
}
}
Then add 14 to height and viewBox.height.
-->
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="650" height="70" viewBox="0 0 650 70" class="WaveDrom"><g transform="translate(0.5,0.5)" text-anchor="middle" font-size="14" font-family="sans-serif" font-weight="normal"><g transform="translate(4,21)"><g stroke="black" stroke-width="1" stroke-linecap="round"><line x2="641"></line><line x1="641" x2="641" y2="31"></line><line x2="641" y1="31" y2="31"></line><line y2="31"></line><line x1="40" x2="40" y2="3"></line><line x1="40" x2="40" y1="31" y2="28"></line><line x1="80" x2="80" y2="3"></line><line x1="80" x2="80" y1="31" y2="28"></line><line x1="120" x2="120" y2="3"></line><line x1="120" x2="120" y1="31" y2="28"></line><line x1="160" x2="160" y2="31"></line><line x1="200" x2="200" y2="3"></line><line x1="200" x2="200" y1="31" y2="28"></line><line x1="240" x2="240" y2="3"></line><line x1="240" x2="240" y1="31" y2="28"></line><line x1="280" x2="280" y2="3"></line><line x1="280" x2="280" y1="31" y2="28"></line><line x1="321" x2="321" y2="31"></line><line x1="361" x2="361" y2="3"></line><line x1="361" x2="361" y1="31" y2="28"></line><line x1="401" x2="401" y2="3"></line><line x1="401" x2="401" y1="31" y2="28"></line><line x1="441" x2="441" y2="3"></line><line x1="441" x2="441" y1="31" y2="28"></line><line x1="481" x2="481" y2="31"></line><line x1="521" x2="521" y2="3"></line><line x1="521" x2="521" y1="31" y2="28"></line><line x1="561" x2="561" y2="3"></line><line x1="561" x2="561" y1="31" y2="28"></line><line x1="601" x2="601" y2="3"></line><line x1="601" x2="601" y1="31" y2="28"></line></g><g><g></g><g transform="translate(20,-11)"></g><g transform="translate(20,15)"><g transform="translate(60)"><text y="6"><tspan>[0]</tspan></text></g><g transform="translate(220)"><text y="6"><tspan>[1]</tspan></text></g><g transform="translate(381)"><text y="6"><tspan>[2]</tspan></text></g><g transform="translate(541)"><text y="6"><tspan>[3]</tspan></text></g></g><g transform="translate(20,39)"></g></g></g><g transform="translate(4,-3)"><g transform="translate(20,11)"><text y="6">0</text></g><g transform="translate(140,11)"><text y="6">3</text></g><g transform="translate(180,11)"><text y="6">4</text></g><g transform="translate(300,11)"><text y="6">7</text></g><g transform="translate(341,11)"><text y="6">8</text></g><g transform="translate(461,11)"><text y="6">11</text></g><g transform="translate(501,11)"><text y="6">12</text></g><g transform="translate(621,11)"><text y="6">15</text></g></g></g></svg>
Side by side

Before

Width:  |  Height:  |  Size: 2.8 KiB

27
docs/stdlib/_images/data/flexible_layout.svg
View file

File diff suppressed because one or more lines are too long
Side by side

Before

Width:  |  Height:  |  Size: 8.7 KiB

18
docs/stdlib/_images/data/rgb565_layout.svg
View file

@ -1,18 +0,0 @@
<!--
Render the following with wavedrom-bitfield:
{
"reg": [
{"name": ".red", "bits": 5, type: 2},
{"name": ".green", "bits": 6, type: 3},
{"name": ".blue", "bits": 5, type: 4}
],
"config": {
"lanes": 1,
"compact": true,
"vflip": true,
"hspace": 650
}
}
-->
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="650" height="56" viewBox="0 0 650 56" class="WaveDrom"><g transform="translate(0.5,0.5)" text-anchor="middle" font-size="14" font-family="sans-serif" font-weight="normal"><g transform="translate(4,21)"><g stroke="black" stroke-width="1" stroke-linecap="round"><line x2="641"></line><line x1="641" x2="641" y2="31"></line><line x2="641" y1="31" y2="31"></line><line y2="31"></line><line x1="40" x2="40" y2="3"></line><line x1="40" x2="40" y1="31" y2="28"></line><line x1="80" x2="80" y2="3"></line><line x1="80" x2="80" y1="31" y2="28"></line><line x1="120" x2="120" y2="3"></line><line x1="120" x2="120" y1="31" y2="28"></line><line x1="160" x2="160" y2="3"></line><line x1="160" x2="160" y1="31" y2="28"></line><line x1="200" x2="200" y2="31"></line><line x1="240" x2="240" y2="3"></line><line x1="240" x2="240" y1="31" y2="28"></line><line x1="280" x2="280" y2="3"></line><line x1="280" x2="280" y1="31" y2="28"></line><line x1="321" x2="321" y2="3"></line><line x1="321" x2="321" y1="31" y2="28"></line><line x1="361" x2="361" y2="3"></line><line x1="361" x2="361" y1="31" y2="28"></line><line x1="401" x2="401" y2="3"></line><line x1="401" x2="401" y1="31" y2="28"></line><line x1="441" x2="441" y2="31"></line><line x1="481" x2="481" y2="3"></line><line x1="481" x2="481" y1="31" y2="28"></line><line x1="521" x2="521" y2="3"></line><line x1="521" x2="521" y1="31" y2="28"></line><line x1="561" x2="561" y2="3"></line><line x1="561" x2="561" y1="31" y2="28"></line><line x1="601" x2="601" y2="3"></line><line x1="601" x2="601" y1="31" y2="28"></line></g><g><g><rect width="200" height="31" field=".red" style="fill-opacity:0.1;fill:hsl(0,100%,50%)"></rect><rect x="200" width="240" height="31" field=".green" style="fill-opacity:0.1;fill:hsl(80,100%,50%)"></rect><rect x="441" width="200" height="31" field=".blue" style="fill-opacity:0.1;fill:hsl(170,100%,50%)"></rect></g><g transform="translate(20,-11)"></g><g transform="translate(20,15)"><g transform="translate(80)"><text y="6"><tspan>.red</tspan></text></g><g transform="translate(300)"><text y="6"><tspan>.green</tspan></text></g><g transform="translate(521)"><text y="6"><tspan>.blue</tspan></text></g></g><g transform="translate(20,39)"></g></g></g><g transform="translate(4,-3)"><g transform="translate(20,11)"><text y="6">0</text></g><g transform="translate(180,11)"><text y="6">4</text></g><g transform="translate(220,11)"><text y="6">5</text></g><g transform="translate(421,11)"><text y="6">10</text></g><g transform="translate(461,11)"><text y="6">11</text></g><g transform="translate(621,11)"><text y="6">15</text></g></g></g></svg>
Side by side

Before

Width:  |  Height:  |  Size: 2.9 KiB

20
docs/stdlib/_images/data/struct_layout.svg
View file

@ -1,20 +0,0 @@
<!--
Render the following with wavedrom-bitfield:
{
"reg": [
{"name": ".first", "bits": 3},
{"name": ".second", "bits": 7},
{"name": ".third", "bits": 6}
],
"config": {
"lanes": 1,
"compact": true,
"vflip": true,
"hspace": 650
}
}
Then add 14 to height and viewBox.height.
-->
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="650" height="70" viewBox="0 0 650 70" class="WaveDrom"><g transform="translate(0.5,0.5)" text-anchor="middle" font-size="14" font-family="sans-serif" font-weight="normal"><g transform="translate(4,21)"><g stroke="black" stroke-width="1" stroke-linecap="round"><line x2="641"></line><line x1="641" x2="641" y2="31"></line><line x2="641" y1="31" y2="31"></line><line y2="31"></line><line x1="40" x2="40" y2="3"></line><line x1="40" x2="40" y1="31" y2="28"></line><line x1="80" x2="80" y2="3"></line><line x1="80" x2="80" y1="31" y2="28"></line><line x1="120" x2="120" y2="31"></line><line x1="160" x2="160" y2="3"></line><line x1="160" x2="160" y1="31" y2="28"></line><line x1="200" x2="200" y2="3"></line><line x1="200" x2="200" y1="31" y2="28"></line><line x1="240" x2="240" y2="3"></line><line x1="240" x2="240" y1="31" y2="28"></line><line x1="280" x2="280" y2="3"></line><line x1="280" x2="280" y1="31" y2="28"></line><line x1="321" x2="321" y2="3"></line><line x1="321" x2="321" y1="31" y2="28"></line><line x1="361" x2="361" y2="3"></line><line x1="361" x2="361" y1="31" y2="28"></line><line x1="401" x2="401" y2="31"></line><line x1="441" x2="441" y2="3"></line><line x1="441" x2="441" y1="31" y2="28"></line><line x1="481" x2="481" y2="3"></line><line x1="481" x2="481" y1="31" y2="28"></line><line x1="521" x2="521" y2="3"></line><line x1="521" x2="521" y1="31" y2="28"></line><line x1="561" x2="561" y2="3"></line><line x1="561" x2="561" y1="31" y2="28"></line><line x1="601" x2="601" y2="3"></line><line x1="601" x2="601" y1="31" y2="28"></line></g><g><g></g><g transform="translate(20,-11)"></g><g transform="translate(20,15)"><g transform="translate(40)"><text y="6"><tspan>.first</tspan></text></g><g transform="translate(240)"><text y="6"><tspan>.second</tspan></text></g><g transform="translate(501)"><text y="6"><tspan>.third</tspan></text></g></g><g transform="translate(20,39)"></g></g></g><g transform="translate(4,-3)"><g transform="translate(20,11)"><text y="6">0</text></g><g transform="translate(100,11)"><text y="6">2</text></g><g transform="translate(140,11)"><text y="6">3</text></g><g transform="translate(381,11)"><text y="6">9</text></g><g transform="translate(421,11)"><text y="6">10</text></g><g transform="translate(621,11)"><text y="6">15</text></g></g></g></svg>
Side by side

Before

Width:  |  Height:  |  Size: 2.7 KiB

22
docs/stdlib/_images/data/union_layout.svg
View file

@ -1,22 +0,0 @@
<!--
Render the following with wavedrom-bitfield:
{
"reg": [
{"name": ".third", "bits": 6},
{"name": "", "bits": 1, "type": 1},
{"name": ".second", "bits": 7},
{"name": ".first", "bits": 3},
{"name": "", "bits": 4, "type": 1},
],
"config": {
"lanes": 3,
"compact": true,
"vflip": true,
"hspace": 289.4375
}
}
Then add 14 to height and viewBox.height.
-->
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="289" height="132" viewBox="0 0 289 132" class="WaveDrom"><g transform="translate(0.5,0.5)" text-anchor="middle" font-size="14" font-family="sans-serif" font-weight="normal"><g transform="translate(4,83)"><g stroke="black" stroke-width="1" stroke-linecap="round"><line x2="280"></line><line x1="280" x2="280" y2="31"></line><line x2="280" y1="31" y2="31"></line><line y2="31"></line><line x1="40" x2="40" y2="3"></line><line x1="40" x2="40" y1="31" y2="28"></line><line x1="80" x2="80" y2="3"></line><line x1="80" x2="80" y1="31" y2="28"></line><line x1="120" x2="120" y2="3"></line><line x1="120" x2="120" y1="31" y2="28"></line><line x1="160" x2="160" y2="3"></line><line x1="160" x2="160" y1="31" y2="28"></line><line x1="200" x2="200" y2="3"></line><line x1="200" x2="200" y1="31" y2="28"></line><line x1="240" x2="240" y2="31"></line></g><g><g><rect x="240" width="40" height="31" field="" style="fill-opacity:0.1"></rect></g><g transform="translate(20,-11)"></g><g transform="translate(20,15)"><g transform="translate(100)"><text y="6"><tspan>.third</tspan></text></g><g transform="translate(240)"><text y="6"><tspan></tspan></text></g></g><g transform="translate(20,39)"></g></g></g><g transform="translate(4,52)"><g stroke="black" stroke-width="1" stroke-linecap="round"><line x2="280"></line><line x1="280" x2="280" y2="31"></line><line x2="280" y1="31" y2="31"></line><line y2="31"></line><line x1="40" x2="40" y2="3"></line><line x1="40" x2="40" y1="31" y2="28"></line><line x1="80" x2="80" y2="3"></line><line x1="80" x2="80" y1="31" y2="28"></line><line x1="120" x2="120" y2="3"></line><line x1="120" x2="120" y1="31" y2="28"></line><line x1="160" x2="160" y2="3"></line><line x1="160" x2="160" y1="31" y2="28"></line><line x1="200" x2="200" y2="3"></line><line x1="200" x2="200" y1="31" y2="28"></line><line x1="240" x2="240" y2="3"></line><line x1="240" x2="240" y1="31" y2="28"></line></g><g><g></g><g transform="translate(20,-11)"></g><g transform="translate(20,15)"><g transform="translate(120)"><text y="6"><tspan>.second</tspan></text></g></g><g transform="translate(20,39)"></g></g></g><g transform="translate(4,21)"><g stroke="black" stroke-width="1" stroke-linecap="round"><line x2="280"></line><line x1="280" x2="280" y2="31"></line><line x2="280" y1="31" y2="31"></line><line y2="31"></line><line x1="40" x2="40" y2="3"></line><line x1="40" x2="40" y1="31" y2="28"></line><line x1="80" x2="80" y2="3"></line><line x1="80" x2="80" y1="31" y2="28"></line><line x1="120" x2="120" y2="31"></line><line x1="160" x2="160" y2="3"></line><line x1="160" x2="160" y1="31" y2="28"></line><line x1="200" x2="200" y2="3"></line><line x1="200" x2="200" y1="31" y2="28"></line><line x1="240" x2="240" y2="3"></line><line x1="240" x2="240" y1="31" y2="28"></line></g><g><g><rect x="120" width="160" height="31" field="" style="fill-opacity:0.1"></rect></g><g transform="translate(20,-11)"></g><g transform="translate(20,15)"><g transform="translate(40)"><text y="6"><tspan>.first</tspan></text></g><g transform="translate(180)"><text y="6"><tspan></tspan></text></g></g><g transform="translate(20,39)"></g></g></g><g transform="translate(4,-3)"><g transform="translate(20,11)"><text y="6">0</text></g><g transform="translate(100,11)"><text y="6">2</text></g><g transform="translate(140,11)"><text y="6">3</text></g><g transform="translate(220,11)"><text y="6">5</text></g><g transform="translate(260,11)"><text y="6">6</text></g></g></g></svg>
Side by side

Before

Width:  |  Height:  |  Size: 3.9 KiB

16
docs/stdlib/data.rst
View file

@ -39,7 +39,21 @@ The fundamental Amaranth type is a :class:`Value`: a sequence of bits that can a
For example, consider a module that processes pixels, converting them from RGB to grayscale. The color pixel format is RGB565:
.. image:: _images/data/rgb565_layout.svg
.. wavedrom:: data/rgb565_layout
{
"reg": [
{"name": ".red", "bits": 5, "type": 2},
{"name": ".green", "bits": 6, "type": 3},
{"name": ".blue", "bits": 5, "type": 4}
],
"config": {
"lanes": 1,
"compact": true,
"vflip": true,
"hspace": 650
}
}
This module could be implemented (using a fast but *very* approximate method) as follows:

2
pyproject.toml
View file

@ -71,7 +71,7 @@ test = [
docs = [
"sphinx~=7.1",
"sphinxcontrib-platformpicker~=1.3",
"sphinxcontrib-yowasp-wavedrom~=1.1",
"sphinxcontrib-yowasp-wavedrom==1.4", # exact version to avoid changes in rendering
"sphinx-rtd-theme~=2.0",
"sphinx-autobuild",
]