Add Sphinx doc and helper scripts

Signed-off-by: Travis F. Collins <[email protected]>

Author: tfcollins

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/doxygen/doxyfile.in

@@ -0,0 +1,21 @@
+GENERATE_XML = YES
+INPUT = ../../include/iio
+OUTPUT_DIRECTORY = generated
+
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = YES
+PREDEFINED             = "__api= " \
+                         "__check_ret= " \
+                         "__pure= " \
+                         "__cnst= "
+
+GENERATE_HTML = NO
+GENERATE_LATEX = NO
+
+EXCLUDE                = ../../iio-private.h \
+                         ../../debug.h \
+                         ../../iio-lock.h \
+                         ../../iiod-client.h \
+                         ../../sort.h \
+                         ../../network.h

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=source
+set BUILDDIR=build
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

doc/man_to_rst.py

@@ -0,0 +1,58 @@
+# Convert man pages to reStructuredText
+import os
+
+manfolder = os.path.join(os.path.dirname(__file__), "..","build", "share","man")
+page = ['iio_attr','iio_info','iio_genxml','iio_rwdev','iio_reg','iio_stresstest']
+
+tools = {}
+
+for po in page:
+    print(f"Converting {po} to reStructuredText")
+    p = po + ".1"
+    fullpath = os.path.join(manfolder, p)
+    target = os.path.join("source", "tools", po + ".rst")
+    os.system(f"pandoc --from man --to rst {fullpath} -o {target}")
+
+    # Add title to rst file
+    with open(target, 'r') as file:
+        data = file.readlines()
+
+    # Downgrade all headers by one level
+    for i in range(len(data)):
+        if data[i].startswith("="):
+            data[i] = data[i].replace("=", "-")
+        if data[i].startswith("#"):
+            data[i] = data[i].replace("#", "=")
+
+    data.insert(0, f"{po}\n")
+    data.insert(1, "=" * len(po) + "\n")
+
+    # Remove NAME line and the following line
+    for i in range(len(data)):
+        if data[i].startswith("NAME"):
+            data.pop(i)
+            data.pop(i)
+            ref = data[i+1]
+            print(f"Reference: {ref}")
+            tool = ref.split("-")[0].strip()
+            description = ref.split("-")[1].strip()
+            tools[tool] = description
+            break
+
+    with open(target, 'w') as file:
+        file.writelines(data)
+
+# Build index for cli tools
+print("Building index for cli tools")
+
+index = os.path.join("source", "tools", "index.rst")
+
+with open(index, 'w') as file:
+    file.write("Command Line Tools\n")
+    file.write("==================\n\n")
+    file.write(".. toctree::\n")
+    file.write("   :maxdepth: 1\n\n")
+    for tool in tools:
+        file.write(f"   {tool}\n")
+    file.write("\n\n")
+

doc/requirements_doc.txt

@@ -0,0 +1,7 @@
+sphinx
+https://github.com/analogdevicesinc/doctools/releases/download/latest/adi-doctools.tar.gz
+sphinxcontrib.wavedrom
+myst-parser
+breathe
+sphinx-inline-tabs
+sphinxcontrib-matlabdomain