Revert "Conflicting file restored."

This reverts commit 7c3e2da, reversing
changes made to 296073c.

Author: zahitevrenkaya

.github/scripts/check_guideline.py

@@ -312,7 +312,7 @@ def check_copyright (list_of_lines, lw, edit_files):
 #//
 #//   2. An ADI specific BSD license, which can be found in the top level directory
 #//      of this repository (LICENSE_ADIBSD), and also on-line at:
-#//      https://github.com/analogdevicesinc/hdl/blob/main/LICENSE_ADIBSD
+#//      https://github.com/analogdevicesinc/hdl/blob/master/LICENSE_ADIBSD
 #//      This will allow to generate bit files and not release the source code,
 #//      as long as it attaches to an ADI device.
 #//

.github/scripts/readme_check_guideline.md

@@ -1,4 +1,4 @@
-# User guide for [check_guideline.py](https://github.com/analogdevicesinc/hdl/tree/main/.github/scripts/check_guideline.py)
+# User guide for [check_guideline.py](https://github.com/analogdevicesinc/hdl/tree/master/.github/scripts/check_guideline.py)
 
 ## Prerequisites
 
@@ -10,7 +10,7 @@
 
 ## Rules that are checked
 
-These rules can be found in the [HDL coding guideline](https://github.com/analogdevicesinc/hdl/blob/main/docs/hdl_coding_guideline.md).
+These rules can be found in the [HDL coding guideline](https://github.com/analogdevicesinc/hdl/blob/master/docs/hdl_coding_guideline.md).
 
 ### 1. License header
 

.gitignore

@@ -107,5 +107,3 @@ _build
 .qsys_edit
 .github/CODEOWNERS
 .github/PULL_REQUEST_TEMPLATE.md
-library/**/.lock
-library/**/interfaces/*.sv

README.md

@@ -43,17 +43,13 @@ There is no free replacement for consulting services. If you have questions that
 
 ## Getting started
 
-This repository supports reference designs for different [Analog Devices boards](../main/projects) based on [Intel and Xilinx FPGA development boards](../main/projects/common) or standalone.
+This repository supports reference designs for different [Analog Devices boards](../master/projects) based on [Intel and Xilinx FPGA development boards](../master/projects/common) or standalone.
 
 ### Building documentation
 
-Ensure pip is newer than version 23.
-```
-pip install pip --upgrade
-```
 Install the documentation tools.
 ```
-(cd docs ; pip install -r requirements.txt --upgrade)
+(cd docs ; pip install -r requirements.txt)
 ```
 Build the libraries (recommended).
 ```
@@ -99,14 +95,12 @@ more information.
 
   * If you want to use the most stable code base, always use the [latest release branch](https://github.com/analogdevicesinc/hdl/releases).
 
-  * If you want to use the greatest and latest, check out the [main branch](https://github.com/analogdevicesinc/hdl/tree/main).
+  * If you want to use the greatest and latest, check out the [master branch](https://github.com/analogdevicesinc/hdl/tree/master).
 
 ## Use already built files
 
-You can download already built files and use them as they are.
-For the main branch, they are available at the link inside [this document](https://swdownloads.analog.com/cse/boot_partition_files/main/latest_boot.txt). Keep in mind that the ones from the main branch are not stable all the time.
-We suggest using the latest release branch [2022_r2, here](https://swdownloads.analog.com/cse/boot_partition_files/2022_r2/latest_boot.txt).  
-The files are built from [main branch](https://github.com/analogdevicesinc/hdl/tree/main) whenever there are new commits in HDL or Linux repositories.  
+You can download already built files and use them as they are. They are available on [this link]( https://swdownloads.analog.com/cse/hdl_builds/master/latest_boot_partition.tar.gz).  
+The files are built from [master branch](https://github.com/analogdevicesinc/hdl/tree/master) whenever there are new commits in HDL or Linux repositories.  
 
 > :warning: Pay attention when using already built files, since they are not tested in HW!
 
@@ -120,14 +114,14 @@ terms.
 The user should read each of these license terms, and understand the
 freedoms and responsibilities that he or she has by using this source/core.
 
-See [LICENSE](../main/LICENSE) for more details. The separate license files
+See [LICENSE](../master/LICENSE) for more details. The separate license files
 cab be found here:
 
- * [LICENSE_ADIBSD](../main/LICENSE_ADIBSD)
+ * [LICENSE_ADIBSD](../master/LICENSE_ADIBSD)
 
- * [LICENSE_GPL2](../main/LICENSE_GPL2)
+ * [LICENSE_GPL2](../master/LICENSE_GPL2)
 
- * [LICENSE_LGPL](../main/LICENSE_LGPL)
+ * [LICENSE_LGPL](../master/LICENSE_LGPL)
 
 ## Comprehensive user guide
 

docs/Makefile

@@ -5,9 +5,72 @@ SOURCEDIR     = .
 BUILDDIR      = _build
 
 help:
+	@echo "For help about the container instance, do \`make container-help\`"
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 .PHONY: help Makefile
 
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+#------------------------------------------------------------------------------
+# Container commands
+#------------------------------------------------------------------------------
+
+CONTAINER_IMG      ?=hdl-docs
+CONTAINER_ENGINE    =podman
+CONTAINER_REPO      =${CONTAINER_IMG}
+CONTAINER_IMAGE     =${CONTAINER_IMG}_build
+CONTAINER_VERSION   ?=0.1
+CONTAINER_SHELL     ?=bash -l
+CONTAINER_RUN_EXTRA ?=
+CONTAINER_FORMAT     =$(if $(filter podman,${CONTAINER_ENGINE}),--format docker,)
+
+IF_CONTAINER_RUNS=$(shell ${CONTAINER_ENFINE} container inspect -f '{{.State.Running}}' ${CONTAINER_IMAGE} 2>/dev/null)
+
+CONTAINER_RUN_PARAMS = -it --rm --name=${CONTAINER_IMG} \
+		--name=${CONTAINER_IMAGE} \
+		--workdir=/${CONTAINER_IMG} \
+		--mount type=bind,source=${CURDIR}/../,target=/${CONTAINER_IMG} \
+		${CONTAINER_RUN_EXTRA} \
+		${CONTAINER_REPO}/${CONTAINER_IMAGE}:${CONTAINER_VERSION}
+
+container-login:
+	@if [ "${IF_CONTAINER_RUNS}" != "true" ]; then \
+		${CONTAINER_ENGINE} run ${CONTAINER_RUN_PARAMS} \
+			${CONTAINER_SHELL}; \
+	else \
+		${CONTAINER_ENGINE} exec -it ${CONTAINER_IMAGE} \
+			${CONTAINER_SHELL}; \
+	fi
+
+container-build:
+	@printf "Building container image\n"
+	@${CONTAINER_ENGINE} build --no-cache=true ${CONTAINER_FORMAT} -t ${CONTAINER_REPO}/${CONTAINER_IMAGE}:${CONTAINER_VERSION} -f ./Containerfile .
+
+
+container-html:
+	@${CONTAINER_ENGINE} run ${CONTAINER_RUN_PARAMS} ${CONTAINER_SHELL} -c \
+		"source /.venv/bin/activate ; cd docs ; make html"
+
+container-pdf:
+	@${CONTAINER_ENGINE} run ${CONTAINER_RUN_PARAMS} ${CONTAINER_SHELL} -c \
+		"source /.venv/bin/activate ; cd docs ; make latexpdf"
+
+container-clean:
+	@${CONTAINER_ENGINE} run ${CONTAINER_RUN_PARAMS} ${CONTAINER_SHELL} -c \
+		"source /.venv/bin/activate ; cd docs ; make clean"
+
+.PHONY: container-build container-login container-html container-pdf container-clean
+
+container-help:
+	@printf "The container commands allow to use a container to build the documentation.\n"
+	@printf "Both podman and docker are supported, change the CONTAINER_ENGINE variable to select which to use.\n\n"
+	@printf "Usage: make [options]\n"
+	@printf "\
+Options:\n\
+	container-build       Build the container image with dependencies (do once).\n\
+	container-login       Access the container shell.\n\
+	container-html        Build html documentation.\n\
+	container-latexpdf    Build pdf documentation.\n\
+\n"

docs/conf.py

@@ -1,33 +1,35 @@
-# -- Project information ------------------------------------------------------
+# Configuration file for the Sphinx documentation builder.
+#
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-repository = 'hdl'
-project = 'HDL'
-copyright = '2024, Analog Devices, Inc.'
-author = 'Analog Devices, Inc.'
+# -- Project information -----------------------------------------------------
 
-# -- General configuration ----------------------------------------------------
+project = 'HDL, Analog Devices'
+copyright = '2023, Analog Devices Inc'
+author = 'Analog Devices Inc'
+release = 'v0.1'
+
+# -- General configuration ---------------------------------------------------
+
+import os, sys
+
+user = os.environ.get("USER")
+sys.path.append(os.path.abspath("./extensions"))
 
 extensions = [
-    "sphinx.ext.todo",
-    "sphinx.ext.intersphinx",
-    "sphinxcontrib.wavedrom",
-    "adi_doctools"
+	"sphinx.ext.todo",
+	"sphinx.ext.viewcode",
+	"sphinxcontrib.wavedrom",
+	"symbolator_sphinx",
+	"adi_links",
+	"adi_hdl_parser"
 ]
 
-needs_extensions = {
-    'adi_doctools': '0.3'
-}
+templates_path = ['sources/template']
 
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-source_suffix = '.rst'
-
-# -- External docs configuration ----------------------------------------------
 
-intersphinx_mapping = {
-    'doctools': ('https://analogdevicesinc.github.io/doctools', None)
-}
-
-# -- Custom extensions configuration ------------------------------------------
+# -- Custom extensions configuration -------------------------------------------
 
 hide_collapsible_content = True
 validate_links = False
@@ -37,9 +39,15 @@
 todo_include_todos = True
 todo_emit_warnings = True
 
+# -- Symbolator configuration -------------------------------------------------
+
+symbolator_cmd = f"/home/{user}/.local/bin/symbolator"
+symbolator_cmd_args = ['-t', '--scale=0.75']
+
 # -- Options for HTML output --------------------------------------------------
 
-html_theme = 'cosmic'
+html_theme = 'furo'
 html_static_path = ['sources']
+source_suffix = '.rst'
 html_css_files = ["custom.css"]
 html_favicon = "sources/icon.svg"