zcy
/
pluto_hdl_adi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
pluto_hdl_adi/docs/index.rst

54 lines
1.4 KiB
ReStructuredText
Raw Normal View History

docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
:hide-toc:
HDL Reference Designs
===============================================================================
.. toctree::
docs: move guidelines, porting project main, repos git roles Moves guidelines to user_guide as docs_guidelines. Includes Porting HDL project user guide. Replaces the Excel spreadsheet with raw space divided files. Includes the 6 pinned at the org. Contributors shall expand the list as needed. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-06 18:38:30 +00:00
:caption: User guide
docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
:hidden:
docs: move guidelines, porting project main, repos git roles Moves guidelines to user_guide as docs_guidelines. Includes Porting HDL project user guide. Replaces the Excel spreadsheet with raw space divided files. Includes the 6 pinned at the org. Contributors shall expand the list as needed. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-06 18:38:30 +00:00
user_guide/index
docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
.. toctree::
docs: move guidelines, porting project main, repos git roles Moves guidelines to user_guide as docs_guidelines. Includes Porting HDL project user guide. Replaces the Excel spreadsheet with raw space divided files. Includes the 6 pinned at the org. Contributors shall expand the list as needed. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-06 18:38:30 +00:00
:caption: Libraries
docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
:hidden:
docs: move guidelines, porting project main, repos git roles Moves guidelines to user_guide as docs_guidelines. Includes Porting HDL project user guide. Replaces the Excel spreadsheet with raw space divided files. Includes the 6 pinned at the org. Contributors shall expand the list as needed. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-06 18:38:30 +00:00
library/axi_dmac/index
docs/projects/ad9081 & images: Add ad9081_fmca_ebz project doc Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-10-09 13:22:42 +00:00
library/spi_engine/index
.. toctree::
:caption: Projects
:hidden:
docs: Add ad4134_fmc doc (#1247) * docs: Add ad4134_fmc doc. Update by guidelines Signed-off-by: laurent-19 <laurentiu.popa@analog.com> --------- Signed-off-by: laurent-19 <laurentiu.popa@analog.com>
2024-01-29 12:41:13 +00:00
AD4134-FMC <projects/ad4134_fmc/index>
docs: Add ad469x_fmc doc
2023-11-16 11:58:59 +00:00
AD469X-FMC <projects/ad469x_fmc/index>
docs: Add ad5766 documentation (#1227) docs: Add ad5766_sdz documentation Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2023-12-12 10:12:47 +00:00
AD5766-SDZ <projects/ad5766_sdz/index>
docs: Add ad7134_fmc doc (#1246) * docs: Add ad7134_fmc doc. Update by guidelines Signed-off-by: laurent-19 <laurentiu.popa@analog.com> --------- Signed-off-by: laurent-19 <laurentiu.popa@analog.com>
2024-01-29 12:40:23 +00:00
AD7134-FMC <projects/ad7134_fmc/index>
AD719x: Documentation (#1211) docs/projects/ad719x_asdz: Add documentation for AD719x
2023-11-27 11:27:55 +00:00
AD719X-ASDZ <projects/ad719x_asdz/index>
docs: Add ad738x documentation (#1240) docs/projects/ad738x_fmc: Add ad738x_fmc project documentation Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2023-12-21 09:58:16 +00:00
AD738X-FMC <projects/ad738x_fmc/index>
docs: flatten images paths, toctree and images guidelines (#1222) Recommend storing images like any other artifact: in a hierarchical manner, without "images" subfolders. This is intended to avoid dangling artifacts when projects are moved, renamed, or deleted. Recommend overwriting the page title with a shorter title in the toctree, so the navigation bar doesn't overflow or get too cluttered. Add acostina to CODEOWNERS Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-11-15 15:13:26 +00:00
AD7616-SDZ <projects/ad7616_sdz/index>
AD9081-FMCA-EBZ/AD9082-FMCA-EBZ <projects/ad9081_fmca_ebz/index>
AD9434: Zed porting and documentation (#1210)
2023-12-07 13:18:59 +00:00
AD9434-FMC <projects/ad9434_fmc/index>
docs: flatten images paths, toctree and images guidelines (#1222) Recommend storing images like any other artifact: in a hierarchical manner, without "images" subfolders. This is intended to avoid dangling artifacts when projects are moved, renamed, or deleted. Recommend overwriting the page title with a shorter title in the toctree, so the navigation bar doesn't overflow or get too cluttered. Add acostina to CODEOWNERS Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-11-15 15:13:26 +00:00
AD9783-EBZ <projects/ad9783_ebz/index>
docs: Add adaq7980 documentation
2023-11-13 16:04:31 +00:00
ADAQ7980-SDZ <projects/adaq7980_sdz/index>
docs: Add cn0561 doc (#1245) * docs: Add cn0561 doc. Update by guidelines Signed-off-by: laurent-19 <laurentiu.popa@analog.com> --------- Signed-off-by: laurent-19 <laurentiu.popa@analog.com>
2024-01-29 12:38:53 +00:00
CN0561 <projects/cn0561/index>
docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
docs: Add color roles. Fix :part: link. Remove extension * Remove sphinxcontrib.mermaid extension * Added red and green role * Fixed the :part: role link because analog.com doesn't know to redirect to proper part webpage if it's under /products Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-08-17 13:19:55 +00:00
.. role:: red
.. role:: green
docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
.. attention::
Work-in-progress, not all content available at the
`wiki <https://wiki.analog.com/resources/fpga/docs/build>`_
have been imported yet.
.. image:: sources/HDL_logo.svg
:align: center
:scale: 100%
`Analog Devices Inc. <https://www.analog.com>`_
HDL libraries and projects for various reference design and prototyping systems.
This repository contains HDL code (Verilog or VHDL) and the required Tcl scripts
to create and build a specific FPGA example design using Xilinx and/or Intel tool
docs: Add ad4134_fmc doc (#1247) * docs: Add ad4134_fmc doc. Update by guidelines Signed-off-by: laurent-19 <laurentiu.popa@analog.com> --------- Signed-off-by: laurent-19 <laurentiu.popa@analog.com>
2024-01-29 12:41:13 +00:00
chain.