Skip to content

Commit fa48b93

Browse files
dbkinderAnas Nashif
authored andcommitted
doc: fix missing bluetooth mesh API docs
Sphinx/breathe doesn't support showing nested groups, so explicitly add the nested groups in the API documentation (for Bluetooth Mesh). Also, added an ignore pattern for a nested unnamed type known issue. fixes: issue #5040 Signed-off-by: David B. Kinder <[email protected]>
1 parent 691d709 commit fa48b93

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

.known-issues/doc/bluetooth.conf

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,15 @@
3636
^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected end of definition. \[error at [0-9]+]
3737
^.*bt_gatt_read_params.__unnamed__.*
3838
^[- \t]*\^
39+
#
40+
# Bluetooth mesh unnamed struct definition
41+
#
42+
^(?P<filename>[-._/\w]+/doc/api/bluetooth.rst):(?P<lineno>[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
43+
^[ \t]*
44+
^[ \t]*\^
45+
^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
46+
^[ \t]*
47+
^[ \t]*\^
48+
^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected end of definition. \[error at [0-9]+]
49+
^.*bt_mesh_model.__unnamed__.*
50+
^[- \t]*\^

doc/api/bluetooth.rst

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Bluetooth API
44
#############
55

66
.. contents::
7-
:depth: 1
7+
:depth: 2
88
:local:
99
:backlinks: top
1010

@@ -39,6 +39,43 @@ Mesh Profile
3939
.. doxygengroup:: bt_mesh
4040
:project: Zephyr
4141

42+
Bluetooth Mesh Access Layer
43+
===========================
44+
45+
.. doxygengroup:: bt_mesh_access
46+
:project: Zephyr
47+
48+
Bluetooth Mesh Configuration Client Model
49+
=========================================
50+
51+
.. doxygengroup:: bt_mesh_cfg_cli
52+
:project: Zephyr
53+
54+
Bluetooth Mesh Configuration Server Model
55+
=========================================
56+
57+
.. doxygengroup:: bt_mesh_cfg_srv
58+
:project: Zephyr
59+
60+
Bluetooth Mesh Health Server Model
61+
==================================
62+
63+
.. doxygengroup:: bt_mesh_health_srv
64+
:project: Zephyr
65+
66+
Bluetooth Mesh Provisioning
67+
===========================
68+
69+
.. doxygengroup:: bt_mesh_prov
70+
:project: Zephyr
71+
72+
Bluetooth Mesh Proxy
73+
====================
74+
75+
.. doxygengroup:: bt_mesh_proxy
76+
:project: Zephyr
77+
78+
4279
Universal Unique Identifiers (UUIDs)
4380
************************************
4481

0 commit comments

Comments
 (0)