Skip to content

Commit ff991aa

Browse files
committed
docs: Minor JESD204 changes
Implicit path to library when the doc is hierarchically coherent with the library. Signed-off-by: Jorge Marques <[email protected]>
1 parent bbec9a0 commit ff991aa

File tree

6 files changed

+10
-21
lines changed

6 files changed

+10
-21
lines changed

docs/library/jesd204/ad_ip_jesd204_tpl_adc/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ ADC JESD204B/C Transport Peripheral
44
================================================================================
55

66
.. hdl-component-diagram::
7-
:path: library/jesd204/ad_ip_jesd204_tpl_adc
87

98
The ADC JESD204B/C Transport Peripheral implements the transport level handling
109
of a JESD204B/C transmitter device. It is compatible with a
@@ -353,4 +352,4 @@ Technical Support
353352

354353
Analog Devices will provide limited online support for anyone using the core
355354
with Analog Devices components (ADC, DAC, Video, Audio, etc) via the
356-
:ez:`EngineerZone <fpga>`.
355+
:ez:`EngineerZone <fpga>`.

docs/library/jesd204/ad_ip_jesd204_tpl_dac/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ DAC JESD204B/C Transport Peripheral
44
================================================================================
55

66
.. hdl-component-diagram::
7-
:path: library/jesd204/ad_ip_jesd204_tpl_dac
87

98
The DAC JESD204B/C Transport Peripheral (AD-IP-JESD204-TRANSPORT-DAC) implements
109
the transport level handling of a JESD204B/C transmitter device. It is
@@ -313,4 +312,4 @@ Technical Support
313312

314313
Analog Devices will provide limited online support for anyone using the core
315314
with Analog Devices components (ADC, DAC, Video, Audio, etc) via the
316-
:ez:`EngineerZone <fpga>`.
315+
:ez:`EngineerZone <fpga>`.

docs/library/jesd204/axi_jesd204_rx/index.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ JESD204B/C Link Receive Peripheral
44
================================================================================
55

66
.. hdl-component-diagram::
7-
:path: library/jesd204/axi_jesd204_rx
87

98
The Analog Devices JESD204B/C Link Receive Peripheral implements the link layer
109
handling of a JESD204 receive logic device. Implements the 8B/10B based link
@@ -111,7 +110,6 @@ AXI JESD204 RX Synthesis Configuration Parameters
111110
--------------------------------------------------------------------------------
112111

113112
.. hdl-parameters::
114-
:path: library/jesd204/axi_jesd204_rx
115113

116114
* - ID
117115
- Instance identification number.
@@ -152,7 +150,6 @@ AXI JESD204 RX Signal and Interface Pins
152150
--------------------------------------------------------------------------------
153151

154152
.. hdl-interfaces::
155-
:path: library/jesd204/axi_jesd204_rx
156153

157154
* - s_axi_aclk
158155
- All ``S_AXI`` signals and ``irq`` are synchronous to this clock.
@@ -1188,4 +1185,4 @@ encounter.
11881185
More Information
11891186
--------------------------------------------------------------------------------
11901187

1191-
- :ref:`JESD204 High-Speed Serial Interface Support <jesd204>`
1188+
- :ref:`JESD204 High-Speed Serial Interface Support <jesd204>`

docs/library/jesd204/axi_jesd204_tx/index.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ JESD204B/C Link Transmit Peripheral
44
================================================================================
55

66
.. hdl-component-diagram::
7-
:path: library/jesd204/axi_jesd204_tx
8-
97

108
The Analog Devices JESD204B/C Link Transmit Peripheral implements the link layer
119
handling of a JESD204 transmit logic device. Implements the 8B/10B based link
@@ -111,7 +109,6 @@ AXI JESD204 TX Synthesis Configuration Parameters
111109
--------------------------------------------------------------------------------
112110

113111
.. hdl-parameters::
114-
:path: library/jesd204/axi_jesd204_tx
115112

116113
* - ID
117114
- Instance identification number.
@@ -152,7 +149,6 @@ AXI JESD204 TX Signal and Interface Pins
152149
--------------------------------------------------------------------------------
153150

154151
.. hdl-interfaces::
155-
:path: library/jesd204/axi_jesd204_tx
156152

157153
* - s_axi_aclk
158154
- All ``S_AXI`` signals and ``irq`` are synchronous to this clock.

docs/library/spi_engine/spi_engine_interconnect.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,13 @@ Signal and Interface Pins
5454
* - resetn
5555
- Synchronous active-low reset.
5656
Resets the internal state of the module.
57-
* - s0_ctrl
57+
* - s*_ctrl
5858
- :ref:`spi_engine control-interface` slave.
59-
Connects to the first control interface master.
60-
* - s1_ctrl
61-
- :ref:`spi_engine control-interface` slave.
62-
Connects to the second control interface master.
59+
| ``s0_ctrl`` connects to the first control interface master.
60+
| ``s1_ctrl`` connects to the second control interface master.
6361
* - m_ctrl
64-
- :ref:`spi_engine control-interface` master.
65-
Connects to the control interface slave.
62+
- | :ref:`spi_engine control-interface` master.
63+
| Connects to the control interface slave.
6664
6765
Theory of Operation
6866
--------------------------------------------------------------------------------

docs/regmap/adi_regmap_xcvr.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
TITLE
2-
Xilinx XCVR (axi_xcvr) Regmap
2+
Xilinx XCVR (axi_xcvr)
33
XCVR
44
ENDTITLE
55

@@ -658,7 +658,7 @@ ENDFIELD
658658
############################################################################################
659659

660660
TITLE
661-
Intel XCVR (axi_xcvr) Regmap
661+
Intel XCVR (axi_xcvr)
662662
INTEL_XCVR
663663
ENDTITLE
664664

0 commit comments

Comments
 (0)