doc: initial revision

Signed-off-by: Adrian Suciu <[email protected]>

doc/.gitignore

@@ -0,0 +1 @@
+!Makefile

doc/Makefile

@@ -0,0 +1,13 @@
+SHELL         = /bin/bash
+SPHINXOPTS   ?=
+SPHINXBUILD  ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/conf.py

@@ -0,0 +1,51 @@
+# -- Import setup -------------------------------------------------------------
+
+from os import path
+
+# -- Project information ------------------------------------------------------
+
+repository = 'hdl'
+project = 'HDL'
+copyright = '2024, Analog Devices, Inc.'
+author = 'Analog Devices, Inc.'
+
+# -- General configuration ----------------------------------------------------
+
+extensions = [
+    "sphinx.ext.todo",
+    "sphinxcontrib.wavedrom",
+    "adi_doctools"
+]
+
+needs_extensions = {
+    'adi_doctools': '0.3'
+}
+
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+source_suffix = '.rst'
+
+# -- External docs configuration ----------------------------------------------
+
+interref_repos = ['doctools']
+
+# -- Custom extensions configuration ------------------------------------------
+
+hide_collapsible_content = True
+validate_links = False
+
+# -- todo configuration -------------------------------------------------------
+
+todo_include_todos = True
+todo_emit_warnings = True
+
+# -- Options for HTML output --------------------------------------------------
+
+html_theme = 'cosmic'
+html_static_path = ['sources']
+html_css_files = ["custom.css"]
+html_favicon = path.join("sources", "icon.svg")
+
+html_theme_options = {
+    "light_logo": "HDL_logo_cropped.svg",
+    "dark_logo": "HDL_logo_w_cropped.svg",
+}

doc/index.rst

@@ -0,0 +1,41 @@
+HDL Reference Designs
+===============================================================================
+
+`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
+chain.
+
+.. note::
+
+   We are in the process of moving the HDL documentation from
+   `wiki.analog.com <https://wiki.analog.com/resources/fpga>`__
+   to :git-hdl:`/`.
+
+   We apologize for any inconvenience that may occur due to this migration.
+
+.. image:: sources/HDL_logo.png
+   :class: only-light
+   :width: 70%
+
+.. image:: sources/HDL_logo_w.png
+   :class: only-dark
+   :width: 70%
+
+.. hdl-build-status::
+
+Contents
+-------------------------------------------------------------------------------
+
+.. toctree::
+   :titlesonly:
+   :includehidden:
+   :maxdepth: 3
+
+   user_guide/index
+
+.. toctree::
+   :maxdepth: 3
+
+   plugins/index

doc/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

doc/plugins/index.rst

@@ -0,0 +1,26 @@
+.. _plugins:
+
+Plugins
+================================================================================
+
+What is a Scopy plugin ?
+
+General IIO plugins
+ADC Plugin
+DAC plugin
+Datalogger
+Debugger
+Register Map
+
+Application Specific plugins
+ADALM2000
+SWIOT1L
+PQM
+
+
+Each plugin:
+Description
+Compatible
+Description
+Usage
+Usecases

doc/requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+https://github.com/analogdevicesinc/doctools/releases/download/latest/adi-doctools.tar.gz
+sphinxcontrib.wavedrom