diff --git a/dev/404.html b/dev/404.html index 24e3495..d0f023b 100644 --- a/dev/404.html +++ b/dev/404.html @@ -16,7 +16,7 @@ - + diff --git a/dev/architecture/index.html b/dev/architecture/index.html index af53583..f5590aa 100644 --- a/dev/architecture/index.html +++ b/dev/architecture/index.html @@ -22,7 +22,7 @@ - + diff --git a/dev/assets/_mkdocstrings.css b/dev/assets/_mkdocstrings.css index 85449ec..b500381 100644 --- a/dev/assets/_mkdocstrings.css +++ b/dev/assets/_mkdocstrings.css @@ -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); diff --git a/dev/ethernet_interface/index.html b/dev/ethernet_interface/index.html index 2d29268..0d18ea8 100644 --- a/dev/ethernet_interface/index.html +++ b/dev/ethernet_interface/index.html @@ -20,7 +20,7 @@ - + @@ -896,7 +896,7 @@ Interface in an Amaranth-native design.
Parameters:
phy
+ phy
(str)
–
clk_freq
+ clk_freq
(int | float)
–
fpga_ip_addr
+ fpga_ip_addr
(str)
–
host_ip_addr
+ host_ip_addr
(str)
–
udp_port
+ udp_port
(Optional[int], default:
2001
)
@@ -946,7 +946,7 @@ FPGA will send packets back to.
**kwargs
+ **kwargs
–
Any additional keyword arguments to this function will @@ -984,6 +984,11 @@ provided below:
+ + + + +Parameters:
inputs
+ inputs
(Optional[List[Signal]], default:
[]
)
@@ -1003,7 +1003,7 @@ at least one probe, but it need not be an input.
outputs
+ outputs
(Optional[List[Signal]], default:
[]
)
@@ -1020,6 +1020,11 @@ at least one probe, but it need not be an output.
+
+
+
+
+
Parameters:
probe
+ probe
(str | Signal)
–
Parameters:
probe
+ probe
(str | Signal)
–
value
+ value
(int)
–
Parameters:
sample_depth
+ sample_depth
(int)
–
probes
+ probes
(List[Signal])
–
Parameters:
trigger_mode
+ trigger_mode
(TriggerMode | str, default:
None
)
@@ -1406,7 +1411,7 @@ containing the capture and its metadata.
triggers
+ triggers
(Optional[Sequence[Sequence[str | int]]], default:
None
)
@@ -1416,7 +1421,7 @@ containing the capture and its metadata.
trigger_location
+ trigger_location
(Optional[int], default:
None
)
@@ -1461,6 +1466,11 @@ CSV file, or a Verilog module.
+
+
+
+
+
Parameters:
path
+ path
(str)
–
Parameters:
path
+ path
(str)
–
Parameters:
name
+ name
(str)
–
Parameters:
mode
+ mode
(str)
–
width
+ width
(int)
–
depth
+ depth
(int)
–
Parameters:
addrs
+ addrs
(int | List[int])
–
Parameters:
addrs
+ addrs
(int | List[int])
–
datas
+ datas
(int | List[int])
–
Parameters:
port
+ port
(str)
–
baudrate
+ baudrate
(float | int)
–
clock_freq
+ clock_freq
(float | int)
–
stall_interval
+ stall_interval
(Optional[int], default:
16
)
@@ -927,7 +927,7 @@ reports that bytes are being dropped.
chunk_size
+ chunk_size
(Optional[int], default:
256
)
@@ -959,6 +959,11 @@ provided, or the clock frequency or baudrate is invalid.
+
+
+
+
+