Skip to content

Commit c0d0357

Browse files
b-gentb-gent
committed
doc: build SD API doc for all SoC variants
Changes across doxygen config files and other doc build files. Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no>
1 parent 48842f1 commit c0d0357

29 files changed

Lines changed: 17314 additions & 31 deletions

‎doc/CMakeLists.txt‎

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -251,15 +251,44 @@ add_docset(nrf-bm ${NRF_BM_VERSION})
251251
add_doxygen_docset(nrf-bm ${NRF_BM_BASE} ${NRF_BM_VERSION})
252252

253253
#-------------------------------------------------------------------------------
254-
# docset: s115
254+
# docset: s115_nrf54l15
255255

256-
add_doxygen_docset(s115 ${NRF_BM_BASE} "10.0.0-1.prototype" STANDALONE)
256+
add_doxygen_docset(s115_nrf54l15 ${NRF_BM_BASE} "10.0.0-1.prototype" STANDALONE)
257257

258258
#-------------------------------------------------------------------------------
259-
# docset: s145
259+
# docset: s145_nrf54l15
260260

261-
add_doxygen_docset(s145 ${NRF_BM_BASE} "10.0.0-1.prototype" STANDALONE)
261+
add_doxygen_docset(s145_nrf54l15 ${NRF_BM_BASE} "10.0.0-1.prototype" STANDALONE)
262262

263+
#-------------------------------------------------------------------------------
264+
# docset: s115_nrf54lm20
265+
266+
add_doxygen_docset(s115_nrf54lm20 ${NRF_BM_BASE} "10.0.0-1.prototype" STANDALONE)
267+
268+
#-------------------------------------------------------------------------------
269+
# docset: s145_nrf54lm20
270+
271+
add_doxygen_docset(s145_nrf54lm20 ${NRF_BM_BASE} "10.0.0-1.prototype" STANDALONE)
272+
273+
#-------------------------------------------------------------------------------
274+
# docset: s115_nrf54ls05
275+
276+
add_doxygen_docset(s115_nrf54ls05 ${NRF_BM_BASE} "10.0.0-1.prototype" STANDALONE)
277+
278+
#-------------------------------------------------------------------------------
279+
# docset: s145_nrf54ls05
280+
281+
add_doxygen_docset(s145_nrf54ls05 ${NRF_BM_BASE} "10.0.0-1.prototype" STANDALONE)
282+
283+
#-------------------------------------------------------------------------------
284+
# docset: s115_nrf54lv10
285+
286+
add_doxygen_docset(s115_nrf54lv10 ${NRF_BM_BASE} "10.0.0-1.prototype" STANDALONE)
287+
288+
#-------------------------------------------------------------------------------
289+
# docset: s145_nrf54lv10
290+
291+
add_doxygen_docset(s145_nrf54lv10 ${NRF_BM_BASE} "10.0.0-1.prototype" STANDALONE)
263292
#-------------------------------------------------------------------------------
264293
# docset: kconfig
265294

@@ -295,16 +324,22 @@ function(add_doc_dependencies docset)
295324
endif()
296325
endfunction()
297326

298-
add_doc_dependencies(nrf-bm kconfig-all s115 s145)
327+
add_doc_dependencies(nrf-bm kconfig-all s115_nrf54l15 s145_nrf54l15 s115_nrf54lm20 s145_nrf54lm20 s115_nrf54ls05 s145_nrf54ls05 s115_nrf54lv10 s145_nrf54lv10)
299328

300329
add_custom_target(build-all ALL)
301330
add_dependencies(build-all
302331
copy-extra-content
303332
merge-search-indexes
304333
nrf-bm-all
305334
kconfig-all
306-
s115
307-
s145
335+
s115_nrf54l15
336+
s145_nrf54l15
337+
s115_nrf54lm20
338+
s145_nrf54lm20
339+
s115_nrf54ls05
340+
s145_nrf54ls05
341+
s115_nrf54lv10
342+
s145_nrf54lv10
308343
)
309344

310345
add_custom_target(linkcheck)

‎doc/nrf-bm/conf.py‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,14 @@
6666
external_content_contents = [
6767
(NRF_BM_BASE / "doc" / "nrf-bm", "*"),
6868
(NRF_BM_BASE, "samples/**/*.rst"),
69-
(SOFTDEVICE_DIR / "nrf54l" / "s115" / "doc", "s115*.main.rst"),
70-
(SOFTDEVICE_DIR / "nrf54l" / "s145" / "doc", "s145*.main.rst"),
69+
(SOFTDEVICE_DIR, "nrf54l/s115/doc/s115*.main.rst"),
70+
(SOFTDEVICE_DIR, "nrf54l/s145/doc/s145*.main.rst"),
71+
(SOFTDEVICE_DIR, "nrf54lm/s115/doc/s115*.main.rst"),
72+
(SOFTDEVICE_DIR, "nrf54lm/s145/doc/s145*.main.rst"),
73+
(SOFTDEVICE_DIR, "nrf54ls/s115/doc/s115*.main.rst"),
74+
(SOFTDEVICE_DIR, "nrf54ls/s145/doc/s145*.main.rst"),
75+
(SOFTDEVICE_DIR, "nrf54lv/s115/doc/s115*.main.rst"),
76+
(SOFTDEVICE_DIR, "nrf54lv/s145/doc/s145*.main.rst"),
7177
]
7278

7379
external_content_keep = ["versions.txt"]
@@ -94,8 +100,14 @@
94100

95101
doxybridge_projects = {
96102
"nrf-bm": _doxyrunner_outdir,
97-
"s115": utils.get_builddir() / "html" / "s115",
98-
"s145": utils.get_builddir() / "html" / "s145",
103+
"s115_nrf54l15": utils.get_builddir() / "html" / "s115_nrf54l15",
104+
"s145_nrf54l15": utils.get_builddir() / "html" / "s145_nrf54l15",
105+
"s115_nrf54lm20": utils.get_builddir() / "html" / "s115_nrf54lm20",
106+
"s145_nrf54lm20": utils.get_builddir() / "html" / "s145_nrf54lm20",
107+
"s115_nrf54ls05": utils.get_builddir() / "html" / "s115_nrf54ls05",
108+
"s145_nrf54ls05": utils.get_builddir() / "html" / "s145_nrf54ls05",
109+
"s115_nrf54lv10": utils.get_builddir() / "html" / "s115_nrf54lv10",
110+
"s145_nrf54lv10": utils.get_builddir() / "html" / "s145_nrf54lv10",
99111
}
100112

101113
# Options for html_redirect ----------------------------------------------------

‎doc/nrf-bm/softdevice/s115_nrf54l15.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _sd_wrapper_s115_nrf54l15:
2+
3+
S115 SoftDevice for nRF54L15/nRF54L10/nRF54L05
4+
##############################################
5+
6+
See the following documentation for the details regarding new releases of this SoftDevice variant.
7+
8+
For additional documentation, see `S115 SoftDevice Specification`_.
9+
10+
.. toctree::
11+
:maxdepth: 2
12+
:glob:
13+
:caption: Subpages:
14+
15+
/nrf54l/s115/doc/*release-notes.main
16+
/nrf54l/s115/doc/*migration-document.main

‎doc/nrf-bm/softdevice/s115_nrf54lm20.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _sd_wrapper_s115_nrf54lm20:
2+
3+
S115 SoftDevice for nRF54LM20
4+
#############################
5+
6+
See the following documentation for the details regarding new releases of this SoftDevice variant.
7+
8+
For additional documentation, see `S115 SoftDevice Specification`_.
9+
10+
.. toctree::
11+
:maxdepth: 2
12+
:glob:
13+
:caption: Subpages:
14+
15+
/nrf54lm/s115/doc/*release-notes.main
16+
/nrf54lm/s115/doc/*migration-document.main

‎doc/nrf-bm/softdevice/s115_nrf54ls05.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _sd_wrapper_s115_nrf54ls05:
2+
3+
S115 SoftDevice for nRF54LS05
4+
#############################
5+
6+
See the following documentation for the details regarding new releases of this SoftDevice variant.
7+
8+
For additional documentation, see `S115 SoftDevice Specification`_.
9+
10+
.. toctree::
11+
:maxdepth: 2
12+
:glob:
13+
:caption: Subpages:
14+
15+
/nrf54ls/s115/doc/*release-notes.main
16+
/nrf54ls/s115/doc/*migration-document.main

‎doc/nrf-bm/softdevice/s115_nrf54lv10.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _sd_wrapper_s115_nrf54lv10:
2+
3+
S115 SoftDevice for nRF54LV10
4+
#############################
5+
6+
See the following documentation for the details regarding new releases of this SoftDevice variant.
7+
8+
For additional documentation, see `S115 SoftDevice Specification`_.
9+
10+
.. toctree::
11+
:maxdepth: 2
12+
:glob:
13+
:caption: Subpages:
14+
15+
/nrf54lv/s115/doc/*release-notes.main
16+
/nrf54lv/s115/doc/*migration-document.main

‎doc/nrf-bm/softdevice/s145_nrf54l15.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _sd_wrapper_s145_nrf54l15:
2+
3+
S145 SoftDevice for nRF54L15/nRF54L10/nRF54L05
4+
##############################################
5+
6+
See the following documentation for the details regarding new releases of this S145 SoftDevice variant.
7+
8+
.. toctree::
9+
:maxdepth: 2
10+
:glob:
11+
:caption: Subpages:
12+
13+
/nrf54l/s145/doc/*release-notes.main
14+
/nrf54l/s145/doc/*migration-document.main

‎doc/nrf-bm/softdevice/s145_nrf54lm20.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _sd_wrapper_s145_nrf54lm20:
2+
3+
S145 SoftDevice for nRF54LM20
4+
#############################
5+
6+
See the following documentation for the details regarding new releases of this S145 SoftDevice variant.
7+
8+
.. toctree::
9+
:maxdepth: 2
10+
:glob:
11+
:caption: Subpages:
12+
13+
/nrf54lm/s145/doc/*release-notes.main
14+
/nrf54lm/s145/doc/*migration-document.main

‎doc/nrf-bm/softdevice/s145_nrf54ls05.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _sd_wrapper_s145_nrf54ls05:
2+
3+
S145 SoftDevice for nRF54LS05
4+
#############################
5+
6+
See the following documentation for the details regarding new releases of this S145 SoftDevice variant.
7+
8+
.. toctree::
9+
:maxdepth: 2
10+
:glob:
11+
:caption: Subpages:
12+
13+
/nrf54ls/s145/doc/*release-notes.main
14+
/nrf54ls/s145/doc/*migration-document.main

‎doc/nrf-bm/softdevice/s145_nrf54lv10.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _sd_wrapper_s145_nrf54lv10:
2+
3+
S145 SoftDevice for nRF54LV10
4+
#############################
5+
6+
See the following documentation for the details regarding new releases of this S145 SoftDevice variant.
7+
8+
.. toctree::
9+
:maxdepth: 2
10+
:glob:
11+
:caption: Subpages:
12+
13+
/nrf54lv/s145/doc/*release-notes.main
14+
/nrf54lv/s145/doc/*migration-document.main

0 commit comments

Comments
 (0)