Link OSAL docs

These docs including doxygen API docs are already present, link them to the main docs. Signed-off-by: Chaitanya Tata <Chaitanya.Tata@nordicsemi.no>
nrfconnect · Sep 27, 2024 · 3e38e61 · 3e38e61
1 parent 9ef8232
commit 3e38e61
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 4 deletions.
diff --git a/nrf70_bm_lib/docs/Doxyfile b/nrf70_bm_lib/docs/Doxyfile
@@ -864,7 +864,10 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../include/nrf70_bm_lib.h
+INPUT                  = ../include/nrf70_bm_lib.h \
+                         ../../../nrfxlib/nrf_wifi/fw_if/umac_if/inc \
+                         ../../../nrfxlib/nrf_wifi/fw_if/umac_if/inc/radio_test \
+                         ../../../nrfxlib/nrf_wifi/fw_if/umac_if/inc/default
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/nrf70_bm_lib/docs/source/conf.py b/nrf70_bm_lib/docs/source/conf.py
@@ -8,7 +8,7 @@
 
 project = 'nRF70 bare metal library'
 copyright = "2024, Nordic Semiconductor"
-author = "Nordic Semiconductor"
+author = "Nordic Semiconductor ASA"
 release = '1.0.0'
 
 # -- General configuration ---------------------------------------------------
@@ -19,7 +19,8 @@
 ]
 
 breathe_projects = {
-    'nrf70_bm_lib': '../xml'
+    'nrf70_bm_lib': '../xml',
+    'nrfxlib': '../xml'
 }
 breathe_default_project = 'nrf70_bm_lib'
 breathe_domain_by_extension = {"h": "c", "c": "c"}
@@ -28,7 +29,9 @@
 templates_path = ['_templates']
 exclude_patterns = []
 
-
+# Ensure the master doc is set correctly
+master_doc = 'index'
+source_suffix = '.rst'
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

diff --git a/nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst b/nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst
@@ -89,6 +89,19 @@ For more information, visit the `nRF Connect SDK nrfxlib repository <https://git
 
    The git submodule pulls in the entire repo, but only `nrf_wifi` directory is required for the BM driver.
 
+nRF70 OS agnostic layers API documentation
+==========================================
+
+The nRF70 Series OS agnostic layers are documented along with the APIs.
+The below modules are part of the nRF70 Series OS agnostic layer:
+
+
+.. toctree::
+  :maxdepth: 1
+
+  nrf70_ll_doc
+
+
 Zephyr build auto-generated files
 *********************************
 

diff --git a/nrf70_bm_lib/docs/source/nrf70_osal_doc.rst b/nrf70_bm_lib/docs/source/nrf70_osal_doc.rst
@@ -0,0 +1,3 @@
+.. include:: ../../../../nrfxlib/nrf_wifi/doc/low_api_common.rst
+.. include:: ../../../../nrfxlib/nrf_wifi/doc/low_api_wifi.rst
+.. include:: ../../../../nrfxlib/nrf_wifi/doc/low_api_radio_test.rst