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

31 lines
828 B
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
HDL Reference Designs
===============================================================================
.. attention::
Work-in-progress, not all content available at the
`wiki <https://wiki.analog.com/resources/fpga/docs/build>`_
docs: Use doctools (#1258) The extensions have been moved to docs tools. The source code is available at https://github.com/analogdevicesinc/doctools And is installed as before: (cd docs ; pip install -r requirements.txt --upgrade) Since the package is listed on the requirements.txt file. Also, add index for library and projects Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2024-02-22 14:32:04 +00:00
has been imported yet.
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
.. 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.
docs: Use doctools (#1258) The extensions have been moved to docs tools. The source code is available at https://github.com/analogdevicesinc/doctools And is installed as before: (cd docs ; pip install -r requirements.txt --upgrade) Since the package is listed on the requirements.txt file. Also, add index for library and projects Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2024-02-22 14:32:04 +00:00
.. hdl-build-status::
Contents
===============================================================================
.. toctree::
:maxdepth: 1
user_guide/index
library/index
projects/index