reference-designs/admx100x_evb: Added ADMX100X documentation

[BCapota]

Type

• Documentation
• Bug fix
• New feature
• Continuous integration

Checklist

• I have performed a self-review of changes
• I have followed the guidelines:
  • https://analogdevicesinc.github.io/documentation/contributing/docs_guidelines.html
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/index.html
  • https://analogdevicesinc.github.io/documentation/contributing/creating_new_pages.html#documentation-structure
• I have used the appropriate roles and directives:
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/roles.html
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/directives.html
• I ensured that binary data was committed to git lfs:
  • https://analogdevicesinc.github.io/documentation/contributing/creating_new_pages.html#adding-images-and-other-binary-files
• I have built the pages I edited or created, using either make html or adoc serve:
  • https://analogdevicesinc.github.io/doctools/cli.html#serve
• I have signed-off my commits and believe my contribution improves the repository.

[StancaPop]

Suggested change

	Ultra-low distortion, low noise signal generator and acquisition evaluation modules.
	Ultra-low distortion, low noise signal generator and acquisition evaluation
	modules.

[StancaPop]

Can you recheck the text wrapping to be of 80 characters/line in all files?

[BCapota]

Sure! Thank you!

[gastmaier]

Fixed on main with 970e3e5, closing and re-opening the pr to regen merge commit

[github-actions]

LLM review

This commit adds the ADMX1001 & ADMX1002 evaluation board documentation, imported from the DokuWiki page at https://wiki.analog.com/resources/eval/user-guides/admx/admx100x. The content is largely correct and the build is clean. Four issues were found and a fixup patch is provided.

run: N/A — no CI run ID recorded

48115a1 - reference-designs/admx100x_evb: Added ADMX100X doc

Broken wiki media link: quickstart/sdp-h1.rst line 64 contains a numbered list item that is a raw URL to a wiki-internal PDF file (https://wiki.analog.com/_media/resources/eval/user-guides/admx/sdp_drivers_installation_instruction.pdf). The link syntax is also malformed RST (#. - ... mixes ordered and unordered list markers). The surrounding step already directs users to the SDP-H1 product page; this item was removed.

Missing SYNC_OUT in SMA connector table: quickstart/sdp-h1.rst Table 1 (SMA Connector) ends at SYNC_IN and omits SYNC_OUT, which appears in user-guide.rst Table 1 and in the device documentation. Entry added.

Side-by-side figures with :align: left: index.rst lines 8–19 use two consecutive .. figure:: directives with :align: left to place the ADMX1001 and ADMX1002 images side by side. The guidelines require the .. grid:: directive for responsive layout. Fixed.

Orphaned wiki figure number references: quickstart/sdp-h1.rst retains wiki-style explicit figure numbers ("Figure 4 shows...", "shown in Figure 20", "as shown in Figure 26", etc.) with no corresponding numbered figures in the RST output. Reworded to remove numeric references at lines 449–450, 606, 699, 722, 741, 762, 815.

Structural note (not fixed): quickstart/sdp-h1.rst is 1265 lines and contains the full general description, all operation modes, GUI overview, and applications information that logically belongs in user-guide.rst. The user guide currently covers only hardware overview and basic software installation (126 lines). A future restructuring of these sections is recommended.

Verification data

The original DokuWiki source was fetched from https://wiki.analog.com/resources/eval/user-guides/admx/admx100x?do=export_raw and compared against the submitted RST files section by section. The HDL intersphinx inventory was checked to confirm admx100x_evb and spi_engine labels resolve correctly. The documentation was built with cd docs; make html — succeeded cleanly before and after fixes.

Suggested patches

Apply the suggested patches with:

cd path/to/repository
export GITHUB_TOKEN=ghp_***
apply-patches --repo=analogdevicesinc/documentation 0

Install instructions

The following one-liner installs the script if not present already:

grep "/apply-patches.sh" ~/.bashrc ||  { curl "https://raw.githubusercontent.com/analogdevicesinc/doctools/refs/heads/main/ci/scripts/apply-patches.sh"    -o ~/.local/bin/apply-patches.sh &&  echo "source ~/.local/bin/apply-patches.sh" >> ~/.bashrc ; source ~/.bashrc ; }

More information at AI Usage.

[StancaPop]

Can you perform a post-processing update in all these files, to modify the length of the headings markers to be either as long as the title, or bounded to 80 characters?

[BCapota]

Done.

[StancaPop]

For long links, there is no problem to have them on a single line, even though they exceed the 80 characters boundary.

Suggested change

	- `ZedBoard
	<https://digilent.com/reference/programmable-logic/zedboard/start>`__ FMC LPC
	- `ZedBoard <https://digilent.com/reference/programmable-logic/zedboard/start>`__ FMC LPC

[StancaPop]

Suggested change

	- AMD Xilinx `ZedBoard
	<https://digilent.com/reference/programmable-logic/zedboard/start>`__ FPGA
	- AMD Xilinx `ZedBoard <https://digilent.com/reference/programmable-logic/zedboard/start>`__ FPGA

[StancaPop]

Suggested change

	#. After the board is connected and a channel is enabled, hit the play button.
	The data capture window can be seen like in the shown picture.
	#. After the board is connected and a channel is enabled, hit the play button.
	The data capture window can be seen like in the shown picture.

[StancaPop]

Suggested change

	:adi:`EVAL-ADMX100X-FMCZ product page
	<en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-admx100x-fmcz.html>`.
	:adi:`EVAL-ADMX100X-FMCZ product page <en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-admx100x-fmcz.html>`.

[StancaPop]

Suggested change

	#. :adi:`ADMX100X GUI
	<media/en/evaluation-boards-kits/evaluation-software/admx100x-evaluation-software.zip>`
	#. :adi:`ADMX100X GUI <media/en/evaluation-boards-kits/evaluation-software/admx100x-evaluation-software.zip>`

[StancaPop]

Suggested change

	- :adi:`SDP-H1
	<en/resources/evaluation-hardware-and-software/evaluation-boards-kits/sdp-h1.html>`
	(recommended, required for ADMX1001 acquisition channel)
	- :adi:`SDP-H1 <en/resources/evaluation-hardware-and-software/evaluation-boards-kits/sdp-h1.html>`
	(recommended, required for ADMX1001 acquisition channel)

[StancaPop]

Suggested change

	- :adi:`SDP-S
	<en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-sdp-cs1z.html>`
	- :adi:`SDP-S <en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-sdp-cs1z.html>`

[StancaPop]

Suggested change

	or :adi:`SDP-B
	<en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-sdp-cb1z.html>`
	or :adi:`SDP-B <en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-sdp-cb1z.html>`

[StancaPop]

Suggested change

	with :adi:`SDP-I-PMOD
	<en/resources/evaluation-hardware-and-software/evaluation-boards-kits/sdp-i-pmod.html>`
	with :adi:`SDP-I-PMOD <en/resources/evaluation-hardware-and-software/evaluation-boards-kits/sdp-i-pmod.html>`