diff --git a/README.md b/README.md index 4bde691..3cf204e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ -========================= nRF70 BM Driver README -========================= +====================== Setup Instructions ================== diff --git a/nrf70_bm_lib/docs/Doxyfile b/nrf70_bm_lib/docs/Doxyfile index 87d5ca2..910fc78 100644 --- 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 index 7c43086..fdd3de5 100644 --- 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 index bebd264..7aed898 100644 --- 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