Add documentation

Add doxygen and sphinx based documentation, primarily for the APIs.

Signed-off-by: Chaitanya Tata <Chaitanya.Tata@nordicsemi.no>

Author: krish2718

.gitignore

@@ -0,0 +1,13 @@
+# Sphinx build directories
+_build/
+build/
+html/
+latex/
+
+# Doxygen generated files
+xml/
+
+# Temporary files
+*.log
+*.tmp
+*.bak

nrf70_bm_lib/docs/Doxyfile

@@ -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)

nrf70_bm_lib/docs/Makefile

@@ -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

nrf70_bm_lib/docs/make.bat

@@ -0,0 +1,37 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'nRF70 bare metal library'
+copyright = "2024, Nordic Semiconductor"
+author = "Nordic Semiconductor"
+release = '1.0.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'breathe',
+]
+
+breathe_projects = {
+    'nrf70_bm_lib': '../xml'
+}
+breathe_default_project = 'nrf70_bm_lib'
+breathe_domain_by_extension = {"h": "c", "c": "c"}
+breathe_separate_member_pages = True
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

nrf70_bm_lib/docs/source/conf.py

@@ -0,0 +1,22 @@
+.. nRF70 bare metal library documentation master file, created by
+   sphinx-quickstart on Wed Jul 31 20:44:22 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to nRF70 bare metal library's documentation!
+====================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   nrf70_bm_lib
+   nrf70_bm_api
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

nrf70_bm_lib/docs/source/index.rst

@@ -0,0 +1,7 @@
+.. _nrf70_bm_api:
+
+API documentation
+=================
+
+.. doxygenfile:: nrf70_bm_lib.h
+   :project: nrf70_bm_lib

nrf70_bm_lib/docs/source/nrf70_bm_api.rst

@@ -0,0 +1,10 @@
+.. _nrf70_bm_lib:
+
+Introduction
+============
+
+nRF70 bare metal library is a library that provides a set of APIs to interact with the nRF70 series of SoCs.
+The library is designed to be used in a bare metal environment, and it is not dependent on any RTOS.
+This helps customers to port the library to any platform of their choice.
+
+The library uses the OS agnostic nRF70 Wi-Fi library to interact with the nRF70.