Skip to content

Commit b20784d

Browse files
Thalleyhenrikbrixandersen
authored andcommitted
docs: Bluetooth: Move documentating for shell out of API
The API directory really isn't the best place for shell documentation, which isn't API. Created a new directory for Bluetooth shell documentation and moved the ISO and LE Audio docs in there. The existing bluetooth-shell.rst file was also split into several new files, so that it follows the same structure. Signed-off-by: Emil Gydesen <[email protected]>
1 parent 39889c0 commit b20784d

File tree

19 files changed

+537
-507
lines changed

19 files changed

+537
-507
lines changed

MAINTAINERS.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -390,8 +390,10 @@ Bluetooth Host:
390390
- doc/connectivity/bluetooth/img/ctlr*
391391
- doc/connectivity/bluetooth/api/audio/
392392
- doc/connectivity/bluetooth/api/mesh/
393-
- doc/connectivity/bluetooth/api/shell/iso.rst
394393
- doc/connectivity/bluetooth/api/controller.rst
394+
- doc/connectivity/bluetooth/shell/classic/a2dp.rst
395+
- doc/connectivity/bluetooth/shell/host/iso.rst
396+
- doc/connectivity/bluetooth/shell/audio/
395397
- samples/bluetooth/bap*/
396398
- samples/bluetooth/cap*/
397399
- samples/bluetooth/hap*/
@@ -475,6 +477,7 @@ Bluetooth Audio:
475477
- tests/bluetooth/tester/overlay-le-audio.conf
476478
- tests/bluetooth/tester/src/audio/
477479
- doc/connectivity/bluetooth/api/audio/
480+
- doc/connectivity/bluetooth/shell/audio/
478481
- samples/bluetooth/bap*/
479482
- samples/bluetooth/cap*/
480483
- samples/bluetooth/hap*/
@@ -493,6 +496,7 @@ Bluetooth Classic:
493496
collaborators:
494497
- jhedberg
495498
files:
499+
- doc/connectivity/bluetooth/shell/classic/a2dp.rst
496500
- subsys/bluetooth/common/
497501
- subsys/bluetooth/host/classic/
498502
- include/zephyr/bluetooth/classic/
@@ -512,7 +516,7 @@ Bluetooth ISO:
512516
- rugeGerritsen
513517
files:
514518
- include/zephyr/bluetooth/iso.h
515-
- doc/connectivity/bluetooth/api/shell/iso.rst
519+
- doc/connectivity/bluetooth/shell/host/iso.rst
516520
- samples/bluetooth/iso_*/
517521
- subsys/bluetooth/Kconfig.iso
518522
- subsys/bluetooth/host/iso.c

doc/_scripts/redirects.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@
2626
('boards/x86/intel_ehl/doc/index', 'boards/intel/ehl/doc/index'),
2727
('boards/x86/intel_rpl/doc/index', 'boards/intel/rpl/doc/index'),
2828
('boards/x86/rpl_crb/doc/index', 'boards/x86/intel_rpl/doc/index'),
29+
30+
('connectivity/bluetooth/api/audio/shell/bap', 'connectivity/bluetooth/shell/audio/bap'),
31+
('connectivity/bluetooth/api/audio/shell/bap_broadcast_assistant', 'connectivity/bluetooth/shell/audio/bap_broadcast_assistant'),
32+
('connectivity/bluetooth/api/audio/shell/bap_scan_delegator', 'connectivity/bluetooth/shell/audio/bap_scan_delegator'),
33+
('connectivity/bluetooth/api/audio/shell/cap', 'connectivity/bluetooth/shell/audio/cap'),
34+
('connectivity/bluetooth/api/audio/shell/ccp', 'connectivity/bluetooth/shell/audio/ccp'),
35+
('connectivity/bluetooth/api/audio/shell/csip', 'connectivity/bluetooth/shell/audio/csip'),
36+
('connectivity/bluetooth/api/audio/shell/gmap', 'connectivity/bluetooth/shell/audio/gmap'),
37+
('connectivity/bluetooth/api/audio/shell/mcp', 'connectivity/bluetooth/shell/audio/mcp'),
38+
('connectivity/bluetooth/api/audio/shell/pbp', 'connectivity/bluetooth/shell/audio/pbp'),
39+
('connectivity/bluetooth/api/audio/shell/tmap', 'connectivity/bluetooth/shell/audio/tmap'),
40+
('connectivity/bluetooth/api/shell/iso', 'connectivity/bluetooth/shell/host/iso'),
2941
('connectivity/bluetooth/audio', 'connectivity/bluetooth/api/audio/audio'),
3042
('connectivity/bluetooth/bap', 'connectivity/bluetooth/api/audio/bap'),
3143
('connectivity/bluetooth/bluetooth-audio-arch', 'connectivity/bluetooth/bluetooth-le-audio-arch'),

doc/connectivity/bluetooth/api/index.rst

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,6 @@ Bluetooth LE Audio
2626
audio/media.rst
2727
audio/microphone.rst
2828
audio/volume.rst
29-
audio/shell/bap.rst
30-
audio/shell/bap_broadcast_assistant.rst
31-
audio/shell/bap_scan_delegator.rst
32-
audio/shell/cap.rst
33-
audio/shell/ccp.rst
34-
audio/shell/csip.rst
35-
audio/shell/gmap.rst
36-
audio/shell/mcp.rst
37-
audio/shell/tmap.rst
38-
audio/shell/pbp.rst
3929

4030
Bluetooth LE Host
4131
=================
@@ -45,7 +35,6 @@ Bluetooth LE Host
4535

4636
services.rst
4737
gap.rst
48-
shell/iso.rst
4938
gatt.rst
5039
att.rst
5140

0 commit comments

Comments
 (0)