docs: add docs/library/axi_adrv9001 #1551
Conversation
Adds documentation for the axi ADRV9001 library Signed-off-by: Carlos Souza <[email protected]>
caosjr
requested review from
IuliaCMoldovan,
gastmaier,
StancaPop and
LBFFilho
as code owners
fixes the svg image for the axi_adrv9001 and contains several cosmetic changes in the text. Signed-off-by: Carlos Souza <[email protected]>
Signed-off-by: Carlos Souza <[email protected]>
There was a problem hiding this comment.
The page does not follow the template https://github.com/analogdevicesinc/hdl/blob/main/docs/library/template_ip/index.rst?plain=1 .
E.g. is missing the Files section, has the Technical Support that was dropped.
It is important to follow the templates, one handy trick of the doc is to cycle the pages anchored on a particular section using Ctrl+Alt+Shift+Left/Right so we can "batch" check on particular section.
Below is a review commit with a few changes (trailing whitespace etc) but please update following the template.
0001-review-docs-add-docs-library-axi_adrv9001.patch
I see that hdl-component-diagram is komisch for this IP. We should report bugs and fix them instead of simply not including it.
| ADCs that contains the up_adc_channel and up_adc_common modules can be read in | ||
| :ref:`axi_adc`. Regarding the DAC, more information related to its generic | ||
| framework can be found at :ref:`axi_dac`. | ||
|
|
There was a problem hiding this comment.
Adding the Features section containing a list of features helps the hdl-component-diagram to not look so weird on the page.
Adds documentation for the axi ADRV9001 library
PR Description
Please replace this comment with summary, motivation and context of the changes.
List any dependencies required for this change.
You can check the checkboxes below by inserting a 'x' between square brackets
(without any other characters or spaces) or just check them after publishing the PR.
If there is a breaking change, specify dependent PRs in description and
try to push all related PRs at the same time.
PR Type
PR Checklist