luke
/
manta
mirror of https://github.com/fischermoseley/manta.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Deployed 599384e to dev with MkDocs 1.6.1 and mike 2.1.3

This commit is contained in:
github-actions[bot] 2024-10-12 21:38:05 +00:00
parent bf1ea345aa
commit 3482e8eee0
15 changed files with 113 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
dev/404.html
View File

@ -16,7 +16,7 @@
<link rel="icon" href="/manta/dev/assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">

2
dev/architecture/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">

26
dev/assets/_mkdocstrings.css
View File

@ -26,20 +26,33 @@
float: right;
}
/* Parameter headings must be inline, not blocks. */
.doc-heading-parameter {
display: inline;
}
/* Prefer space on the right, not the left of parameter permalinks. */
.doc-heading-parameter .headerlink {
margin-left: 0 !important;
margin-right: 0.2rem;
}
/* Backward-compatibility: docstring section titles in bold. */
.doc-section-title {
font-weight: bold;
}
/* Symbols in Navigation and ToC. */
:root,
:root, :host,
[data-md-color-scheme="default"] {
--doc-symbol-parameter-fg-color: #df50af;
--doc-symbol-attribute-fg-color: #953800;
--doc-symbol-function-fg-color: #8250df;
--doc-symbol-method-fg-color: #8250df;
--doc-symbol-class-fg-color: #0550ae;
--doc-symbol-module-fg-color: #5cad0f;
--doc-symbol-parameter-bg-color: #df50af1a;
--doc-symbol-attribute-bg-color: #9538001a;
--doc-symbol-function-bg-color: #8250df1a;
--doc-symbol-method-bg-color: #8250df1a;
@ -48,12 +61,14 @@
}
[data-md-color-scheme="slate"] {
--doc-symbol-parameter-fg-color: #ffa8cc;
--doc-symbol-attribute-fg-color: #ffa657;
--doc-symbol-function-fg-color: #d2a8ff;
--doc-symbol-method-fg-color: #d2a8ff;
--doc-symbol-class-fg-color: #79c0ff;
--doc-symbol-module-fg-color: #baff79;
--doc-symbol-parameter-bg-color: #ffa8cc1a;
--doc-symbol-attribute-bg-color: #ffa6571a;
--doc-symbol-function-bg-color: #d2a8ff1a;
--doc-symbol-method-bg-color: #d2a8ff1a;
@ -68,6 +83,15 @@ code.doc-symbol {
font-weight: bold;
}
code.doc-symbol-parameter {
color: var(--doc-symbol-parameter-fg-color);
background-color: var(--doc-symbol-parameter-bg-color);
}
code.doc-symbol-parameter::after {
content: "param";
}
code.doc-symbol-attribute {
color: var(--doc-symbol-attribute-fg-color);
background-color: var(--doc-symbol-attribute-bg-color);

19
dev/ethernet_interface/index.html
View File

@ -20,7 +20,7 @@
<link rel="icon" href="../assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">
@ -896,7 +896,7 @@ Interface in an Amaranth-native design.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>phy</code></b>
<b><code>phy</code></b>
(<code>str</code>)
–
<div class="doc-md-description">
@ -906,7 +906,7 @@ for your FPGA vendor and family.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>clk_freq</code></b>
<b><code>clk_freq</code></b>
(<code>int | float</code>)
–
<div class="doc-md-description">
@ -915,7 +915,7 @@ Manta module on the FPGA, in Hertz (Hz).</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>fpga_ip_addr</code></b>
<b><code>fpga_ip_addr</code></b>
(<code>str</code>)
–
<div class="doc-md-description">
@ -927,7 +927,7 @@ connected devices.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>host_ip_addr</code></b>
<b><code>host_ip_addr</code></b>
(<code>str</code>)
–
<div class="doc-md-description">
@ -936,7 +936,7 @@ FPGA will send packets back to.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>udp_port</code></b>
<b><code>udp_port</code></b>
(<code>Optional[int]</code>, default:
<code>2001</code>
)
@ -946,7 +946,7 @@ FPGA will send packets back to.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>**kwargs</code></b>
<b><code>**kwargs</code></b>
–
<div class="doc-md-description">
<p>Any additional keyword arguments to this function will
@ -984,6 +984,11 @@ provided below:</p>
<div class="doc doc-children">

2
dev/getting_started/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">

2
dev/index.html
View File

@ -20,7 +20,7 @@
<link rel="icon" href="assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">

2
dev/installation/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">

17
dev/io_core/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">
@ -990,7 +990,7 @@ Amaranth-native design.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>inputs</code></b>
<b><code>inputs</code></b>
(<code>Optional[List[<span title="amaranth.Signal">Signal</span>]]</code>, default:
<code>[]</code>
)
@ -1003,7 +1003,7 @@ at least one probe, but it need not be an input.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>outputs</code></b>
<b><code>outputs</code></b>
(<code>Optional[List[<span title="amaranth.Signal">Signal</span>]]</code>, default:
<code>[]</code>
)
@ -1020,6 +1020,11 @@ at least one probe, but it need not be an output.</p>
<div class="doc doc-children">
@ -1053,7 +1058,7 @@ blocking.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>probe</code></b>
<b><code>probe</code></b>
(<code>str | <span title="amaranth.Signal">Signal</span></code>)
–
<div class="doc-md-description">
@ -1116,7 +1121,7 @@ were found with the same name.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>probe</code></b>
<b><code>probe</code></b>
(<code>str | <span title="amaranth.Signal">Signal</span></code>)
–
<div class="doc-md-description">
@ -1128,7 +1133,7 @@ Amaranth Signals are typically used in Amaranth-native designs.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>value</code></b>
<b><code>value</code></b>
(<code>int</code>)
–
<div class="doc-md-description">

33
dev/logic_analyzer_core/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">
@ -1312,7 +1312,7 @@ an Amaranth-native design.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>sample_depth</code></b>
<b><code>sample_depth</code></b>
(<code>int</code>)
–
<div class="doc-md-description">
@ -1322,7 +1322,7 @@ what the probes are doing over a longer time interval.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>probes</code></b>
<b><code>probes</code></b>
(<code>List[Signal]</code>)
–
<div class="doc-md-description">
@ -1336,6 +1336,11 @@ a width.</p>
<div class="doc doc-children">
@ -1396,7 +1401,7 @@ containing the capture and its metadata.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>trigger_mode</code></b>
<b><code>trigger_mode</code></b>
(<code>TriggerMode | str</code>, default:
<code>None</code>
)
@ -1406,7 +1411,7 @@ containing the capture and its metadata.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>triggers</code></b>
<b><code>triggers</code></b>
(<code>Optional[Sequence[Sequence[str | int]]]</code>, default:
<code>None</code>
)
@ -1416,7 +1421,7 @@ containing the capture and its metadata.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>trigger_location</code></b>
<b><code>trigger_location</code></b>
(<code>Optional[int]</code>, default:
<code>None</code>
)
@ -1461,6 +1466,11 @@ CSV file, or a Verilog module.</p>
<div class="doc doc-children">
@ -1490,7 +1500,7 @@ CSV file, or a Verilog module.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>path</code></b>
<b><code>path</code></b>
(<code>str</code>)
–
<div class="doc-md-description">
@ -1554,7 +1564,7 @@ on the FPGA directly by including it your build process.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>path</code></b>
<b><code>path</code></b>
(<code>str</code>)
–
<div class="doc-md-description">
@ -1618,7 +1628,7 @@ on the FPGA directly by including it your build process.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>name</code></b>
<b><code>name</code></b>
(<code>str</code>)
–
<div class="doc-md-description">
@ -1696,6 +1706,11 @@ along with the config of the core used to take it.</p>
<div class="doc doc-children">

19
dev/memory_core/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">
@ -995,7 +995,7 @@ Amaranth-native design.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>mode</code></b>
<b><code>mode</code></b>
(<code>str</code>)
–
<div class="doc-md-description">
@ -1009,7 +1009,7 @@ is available on nearly all platforms.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>width</code></b>
<b><code>width</code></b>
(<code>int</code>)
–
<div class="doc-md-description">
@ -1017,7 +1017,7 @@ is available on nearly all platforms.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>depth</code></b>
<b><code>depth</code></b>
(<code>int</code>)
–
<div class="doc-md-description">
@ -1029,6 +1029,11 @@ is available on nearly all platforms.</p>
<div class="doc doc-children">
@ -1062,7 +1067,7 @@ usage where possible. This method is blocking.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>addrs</code></b>
<b><code>addrs</code></b>
(<code>int | List[int]</code>)
–
<div class="doc-md-description">
@ -1124,7 +1129,7 @@ usage where possible. This method is blocking.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>addrs</code></b>
<b><code>addrs</code></b>
(<code>int | List[int]</code>)
–
<div class="doc-md-description">
@ -1133,7 +1138,7 @@ to.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>datas</code></b>
<b><code>datas</code></b>
(<code>int | List[int]</code>)
–
<div class="doc-md-description">

2
dev/similar_tools/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">

22
dev/sitemap.xml
View File

@ -2,46 +2,46 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://fischermoseley.github.io/manta/dev/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
<url>
<loc>https://fischermoseley.github.io/manta/dev/architecture/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
<url>
<loc>https://fischermoseley.github.io/manta/dev/ethernet_interface/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
<url>
<loc>https://fischermoseley.github.io/manta/dev/getting_started/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
<url>
<loc>https://fischermoseley.github.io/manta/dev/installation/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
<url>
<loc>https://fischermoseley.github.io/manta/dev/io_core/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
<url>
<loc>https://fischermoseley.github.io/manta/dev/logic_analyzer_core/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
<url>
<loc>https://fischermoseley.github.io/manta/dev/memory_core/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
<url>
<loc>https://fischermoseley.github.io/manta/dev/similar_tools/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
<url>
<loc>https://fischermoseley.github.io/manta/dev/uart_interface/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
<url>
<loc>https://fischermoseley.github.io/manta/dev/use_cases/</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-12</lastmod>
</url>
</urlset>

BIN
dev/sitemap.xml.gz
View File

Binary file not shown.

17
dev/uart_interface/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">
@ -876,7 +876,7 @@ in an Amaranth-native design.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<ul>
<li class="doc-section-item field-body">
<b><code>port</code></b>
<b><code>port</code></b>
(<code>str</code>)
–
<div class="doc-md-description">
@ -890,7 +890,7 @@ port manually.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>baudrate</code></b>
<b><code>baudrate</code></b>
(<code>float | int</code>)
–
<div class="doc-md-description">
@ -900,7 +900,7 @@ USB/UART chip on your dev board for fastest operation.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>clock_freq</code></b>
<b><code>clock_freq</code></b>
(<code>float | int</code>)
–
<div class="doc-md-description">
@ -911,7 +911,7 @@ baudrate.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>stall_interval</code></b>
<b><code>stall_interval</code></b>
(<code>Optional[int]</code>, default:
<code>16</code>
)
@ -927,7 +927,7 @@ reports that bytes are being dropped.</p>
</div>
</li>
<li class="doc-section-item field-body">
<b><code>chunk_size</code></b>
<b><code>chunk_size</code></b>
(<code>Optional[int]</code>, default:
<code>256</code>
)
@ -959,6 +959,11 @@ provided, or the clock frequency or baudrate is invalid.</p>
<div class="doc doc-children">

2
dev/use_cases/index.html
View File

@ -22,7 +22,7 @@
<link rel="icon" href="../assets/logo_ray_only_with_shadow.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">