From 954eb4face056f62fbc1e5052729884c43589727 Mon Sep 17 00:00:00 2001 From: Emil Gydesen Date: Mon, 29 Apr 2024 12:18:03 +0200 Subject: [PATCH] docs: Bluetooth: Audio: Move audio related files to subdir Add a new subdir, audio, and move all the audio related documentation files to that directory, similar to mesh. Signed-off-by: Emil Gydesen --- MAINTAINERS.yml | 6 +--- doc/_scripts/redirects.py | 18 ++++++++++ .../bluetooth/api/{ => audio}/audio.rst | 0 .../bluetooth/api/{ => audio}/bap.rst | 0 .../audio}/bluetooth-le-audio-arch.rst | 0 .../bluetooth/api/{ => audio}/cap.rst | 0 .../api/{ => audio}/coordinated_sets.rst | 0 .../{ => api/audio}/img/ble_audio_arch.svg | 0 .../{ => api/audio}/img/cap_proc.svg | 0 .../bluetooth/{ => api/audio}/img/gaf.svg | 0 .../{ => api/audio}/img/zephyr_gaf.svg | 0 .../bluetooth/api/{ => audio}/media.rst | 0 .../bluetooth/api/{ => audio}/microphone.rst | 0 .../bluetooth/api/{ => audio}/shell/bap.rst | 0 .../shell/bap_broadcast_assistant.rst | 0 .../{ => audio}/shell/bap_scan_delegator.rst | 0 .../bluetooth/api/{ => audio}/shell/cap.rst | 0 .../bluetooth/api/{ => audio}/shell/ccp.rst | 0 .../bluetooth/api/{ => audio}/shell/csip.rst | 0 .../bluetooth/api/{ => audio}/shell/gmap.rst | 0 .../bluetooth/api/{ => audio}/shell/mcp.rst | 0 .../bluetooth/api/{ => audio}/shell/pbp.rst | 0 .../bluetooth/api/{ => audio}/shell/tmap.rst | 0 .../bluetooth/api/{ => audio}/volume.rst | 0 doc/connectivity/bluetooth/api/index.rst | 36 +++++++++---------- doc/connectivity/bluetooth/index.rst | 2 +- 26 files changed, 38 insertions(+), 24 deletions(-) rename doc/connectivity/bluetooth/api/{ => audio}/audio.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/bap.rst (100%) rename doc/connectivity/bluetooth/{ => api/audio}/bluetooth-le-audio-arch.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/cap.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/coordinated_sets.rst (100%) rename doc/connectivity/bluetooth/{ => api/audio}/img/ble_audio_arch.svg (100%) rename doc/connectivity/bluetooth/{ => api/audio}/img/cap_proc.svg (100%) rename doc/connectivity/bluetooth/{ => api/audio}/img/gaf.svg (100%) rename doc/connectivity/bluetooth/{ => api/audio}/img/zephyr_gaf.svg (100%) rename doc/connectivity/bluetooth/api/{ => audio}/media.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/microphone.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/shell/bap.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/shell/bap_broadcast_assistant.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/shell/bap_scan_delegator.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/shell/cap.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/shell/ccp.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/shell/csip.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/shell/gmap.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/shell/mcp.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/shell/pbp.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/shell/tmap.rst (100%) rename doc/connectivity/bluetooth/api/{ => audio}/volume.rst (100%) diff --git a/MAINTAINERS.yml b/MAINTAINERS.yml index 53de3ee3da2..ee64c0ea640 100644 --- a/MAINTAINERS.yml +++ b/MAINTAINERS.yml @@ -446,11 +446,7 @@ Bluetooth Audio: - tests/bluetooth/audio/ - tests/bsim/bluetooth/audio/ - tests/bluetooth/shell/audio.conf - - doc/connectivity/bluetooth/img/ble_audio_arch.svg - - doc/connectivity/bluetooth/img/cap_proc.svg - - doc/connectivity/bluetooth/img/gaf.svg - - doc/connectivity/bluetooth/img/zephyr_gaf.svg - - doc/connectivity/bluetooth/bluetooth-le-audio-arch.rst + - doc/connectivity/bluetooth/api/audio/ - samples/bluetooth/broadcast_audio*/ - samples/bluetooth/hap*/ - samples/bluetooth/public_broadcast*/ diff --git a/doc/_scripts/redirects.py b/doc/_scripts/redirects.py index 64130c7f87a..bf4f9262749 100644 --- a/doc/_scripts/redirects.py +++ b/doc/_scripts/redirects.py @@ -18,15 +18,33 @@ REDIRECTS = [ ('boards/arduino/uno_r4_minima/doc/index', 'boards/arduino/uno_r4/doc/index'), ('boards/x86/ehl_crb/doc/index', 'boards/x86/intel_ehl/doc/index'), ('boards/x86/rpl_crb/doc/index', 'boards/x86/intel_rpl/doc/index'), + ('connectivity/bluetooth/audio', 'connectivity/bluetooth/api/audio/audio'), + ('connectivity/bluetooth/bap', 'connectivity/bluetooth/api/audio/bap'), ('connectivity/bluetooth/bluetooth-audio-arch', 'connectivity/bluetooth/bluetooth-le-audio-arch'), + ('connectivity/bluetooth/bluetooth-le-audio-arch', 'connectivity/bluetooth/api/audio/bluetooth-le-audio-arch'), + ('connectivity/bluetooth/cap', 'connectivity/bluetooth/api/audio/cap'), + ('connectivity/bluetooth/coordinated_sets', 'connectivity/bluetooth/api/audio/coordinated_sets'), ('connectivity/bluetooth/dis-pics', 'connectivity/bluetooth/ics/dis'), ('connectivity/bluetooth/gap-pics', 'connectivity/bluetooth/ics/gap'), ('connectivity/bluetooth/gatt-pics', 'connectivity/bluetooth/ics/gatt'), ('connectivity/bluetooth/l2cap-pics', 'connectivity/bluetooth/ics/l2cap'), + ('connectivity/bluetooth/media', 'connectivity/bluetooth/api/audio/media'), ('connectivity/bluetooth/mesh-pics', 'connectivity/bluetooth/ics/mesh'), + ('connectivity/bluetooth/microphone', 'connectivity/bluetooth/api/audio/microphone'), ('connectivity/bluetooth/overview', 'connectivity/bluetooth/features'), ('connectivity/bluetooth/rfcomm-pics', 'connectivity/bluetooth/ics/rfcomm'), + ('connectivity/bluetooth/shell/bap', 'connectivity/bluetooth/api/audio/shell/bap'), + ('connectivity/bluetooth/shell/bap_broadcast_assistant', 'connectivity/bluetooth/api/audio/shell/bap_broadcast_assistant'), + ('connectivity/bluetooth/shell/bap_scan_delegator', 'connectivity/bluetooth/api/audio/shell/bap_scan_delegator'), + ('connectivity/bluetooth/shell/cap', 'connectivity/bluetooth/api/audio/shell/cap'), + ('connectivity/bluetooth/shell/ccp', 'connectivity/bluetooth/api/audio/shell/ccp'), + ('connectivity/bluetooth/shell/csip', 'connectivity/bluetooth/api/audio/shell/csip'), + ('connectivity/bluetooth/shell/gmap', 'connectivity/bluetooth/api/audio/shell/gmap'), + ('connectivity/bluetooth/shell/mcp', 'connectivity/bluetooth/api/audio/shell/mcp'), + ('connectivity/bluetooth/shell/pbp', 'connectivity/bluetooth/api/audio/shell/pbp'), + ('connectivity/bluetooth/shell/tmap', 'connectivity/bluetooth/api/audio/shell/tmap'), ('connectivity/bluetooth/sm-pics', 'connectivity/bluetooth/ics/sm'), + ('connectivity/bluetooth/volume', 'connectivity/bluetooth/api/audio/volume'), ('connectivity/networking/networking-api-usage', 'connectivity/networking/api/index'), ('development_process/code_flow', 'project/code_flow'), ('development_process/index', 'project/index'), diff --git a/doc/connectivity/bluetooth/api/audio.rst b/doc/connectivity/bluetooth/api/audio/audio.rst similarity index 100% rename from doc/connectivity/bluetooth/api/audio.rst rename to doc/connectivity/bluetooth/api/audio/audio.rst diff --git a/doc/connectivity/bluetooth/api/bap.rst b/doc/connectivity/bluetooth/api/audio/bap.rst similarity index 100% rename from doc/connectivity/bluetooth/api/bap.rst rename to doc/connectivity/bluetooth/api/audio/bap.rst diff --git a/doc/connectivity/bluetooth/bluetooth-le-audio-arch.rst b/doc/connectivity/bluetooth/api/audio/bluetooth-le-audio-arch.rst similarity index 100% rename from doc/connectivity/bluetooth/bluetooth-le-audio-arch.rst rename to doc/connectivity/bluetooth/api/audio/bluetooth-le-audio-arch.rst diff --git a/doc/connectivity/bluetooth/api/cap.rst b/doc/connectivity/bluetooth/api/audio/cap.rst similarity index 100% rename from doc/connectivity/bluetooth/api/cap.rst rename to doc/connectivity/bluetooth/api/audio/cap.rst diff --git a/doc/connectivity/bluetooth/api/coordinated_sets.rst b/doc/connectivity/bluetooth/api/audio/coordinated_sets.rst similarity index 100% rename from doc/connectivity/bluetooth/api/coordinated_sets.rst rename to doc/connectivity/bluetooth/api/audio/coordinated_sets.rst diff --git a/doc/connectivity/bluetooth/img/ble_audio_arch.svg b/doc/connectivity/bluetooth/api/audio/img/ble_audio_arch.svg similarity index 100% rename from doc/connectivity/bluetooth/img/ble_audio_arch.svg rename to doc/connectivity/bluetooth/api/audio/img/ble_audio_arch.svg diff --git a/doc/connectivity/bluetooth/img/cap_proc.svg b/doc/connectivity/bluetooth/api/audio/img/cap_proc.svg similarity index 100% rename from doc/connectivity/bluetooth/img/cap_proc.svg rename to doc/connectivity/bluetooth/api/audio/img/cap_proc.svg diff --git a/doc/connectivity/bluetooth/img/gaf.svg b/doc/connectivity/bluetooth/api/audio/img/gaf.svg similarity index 100% rename from doc/connectivity/bluetooth/img/gaf.svg rename to doc/connectivity/bluetooth/api/audio/img/gaf.svg diff --git a/doc/connectivity/bluetooth/img/zephyr_gaf.svg b/doc/connectivity/bluetooth/api/audio/img/zephyr_gaf.svg similarity index 100% rename from doc/connectivity/bluetooth/img/zephyr_gaf.svg rename to doc/connectivity/bluetooth/api/audio/img/zephyr_gaf.svg diff --git a/doc/connectivity/bluetooth/api/media.rst b/doc/connectivity/bluetooth/api/audio/media.rst similarity index 100% rename from doc/connectivity/bluetooth/api/media.rst rename to doc/connectivity/bluetooth/api/audio/media.rst diff --git a/doc/connectivity/bluetooth/api/microphone.rst b/doc/connectivity/bluetooth/api/audio/microphone.rst similarity index 100% rename from doc/connectivity/bluetooth/api/microphone.rst rename to doc/connectivity/bluetooth/api/audio/microphone.rst diff --git a/doc/connectivity/bluetooth/api/shell/bap.rst b/doc/connectivity/bluetooth/api/audio/shell/bap.rst similarity index 100% rename from doc/connectivity/bluetooth/api/shell/bap.rst rename to doc/connectivity/bluetooth/api/audio/shell/bap.rst diff --git a/doc/connectivity/bluetooth/api/shell/bap_broadcast_assistant.rst b/doc/connectivity/bluetooth/api/audio/shell/bap_broadcast_assistant.rst similarity index 100% rename from doc/connectivity/bluetooth/api/shell/bap_broadcast_assistant.rst rename to doc/connectivity/bluetooth/api/audio/shell/bap_broadcast_assistant.rst diff --git a/doc/connectivity/bluetooth/api/shell/bap_scan_delegator.rst b/doc/connectivity/bluetooth/api/audio/shell/bap_scan_delegator.rst similarity index 100% rename from doc/connectivity/bluetooth/api/shell/bap_scan_delegator.rst rename to doc/connectivity/bluetooth/api/audio/shell/bap_scan_delegator.rst diff --git a/doc/connectivity/bluetooth/api/shell/cap.rst b/doc/connectivity/bluetooth/api/audio/shell/cap.rst similarity index 100% rename from doc/connectivity/bluetooth/api/shell/cap.rst rename to doc/connectivity/bluetooth/api/audio/shell/cap.rst diff --git a/doc/connectivity/bluetooth/api/shell/ccp.rst b/doc/connectivity/bluetooth/api/audio/shell/ccp.rst similarity index 100% rename from doc/connectivity/bluetooth/api/shell/ccp.rst rename to doc/connectivity/bluetooth/api/audio/shell/ccp.rst diff --git a/doc/connectivity/bluetooth/api/shell/csip.rst b/doc/connectivity/bluetooth/api/audio/shell/csip.rst similarity index 100% rename from doc/connectivity/bluetooth/api/shell/csip.rst rename to doc/connectivity/bluetooth/api/audio/shell/csip.rst diff --git a/doc/connectivity/bluetooth/api/shell/gmap.rst b/doc/connectivity/bluetooth/api/audio/shell/gmap.rst similarity index 100% rename from doc/connectivity/bluetooth/api/shell/gmap.rst rename to doc/connectivity/bluetooth/api/audio/shell/gmap.rst diff --git a/doc/connectivity/bluetooth/api/shell/mcp.rst b/doc/connectivity/bluetooth/api/audio/shell/mcp.rst similarity index 100% rename from doc/connectivity/bluetooth/api/shell/mcp.rst rename to doc/connectivity/bluetooth/api/audio/shell/mcp.rst diff --git a/doc/connectivity/bluetooth/api/shell/pbp.rst b/doc/connectivity/bluetooth/api/audio/shell/pbp.rst similarity index 100% rename from doc/connectivity/bluetooth/api/shell/pbp.rst rename to doc/connectivity/bluetooth/api/audio/shell/pbp.rst diff --git a/doc/connectivity/bluetooth/api/shell/tmap.rst b/doc/connectivity/bluetooth/api/audio/shell/tmap.rst similarity index 100% rename from doc/connectivity/bluetooth/api/shell/tmap.rst rename to doc/connectivity/bluetooth/api/audio/shell/tmap.rst diff --git a/doc/connectivity/bluetooth/api/volume.rst b/doc/connectivity/bluetooth/api/audio/volume.rst similarity index 100% rename from doc/connectivity/bluetooth/api/volume.rst rename to doc/connectivity/bluetooth/api/audio/volume.rst diff --git a/doc/connectivity/bluetooth/api/index.rst b/doc/connectivity/bluetooth/api/index.rst index e9c45edd6de..6135df5e6a2 100644 --- a/doc/connectivity/bluetooth/api/index.rst +++ b/doc/connectivity/bluetooth/api/index.rst @@ -19,24 +19,23 @@ Bluetooth LE Audio .. toctree:: :maxdepth: 1 - audio.rst - bap.rst - cap.rst - coordinated_sets.rst - media.rst - microphone.rst - volume.rst - shell/bap.rst - shell/bap_broadcast_assistant.rst - shell/bap_scan_delegator.rst - shell/cap.rst - shell/ccp.rst - shell/csip.rst - shell/gmap.rst - shell/iso.rst - shell/mcp.rst - shell/tmap.rst - shell/pbp.rst + audio/audio.rst + audio/bap.rst + audio/cap.rst + audio/coordinated_sets.rst + audio/media.rst + audio/microphone.rst + audio/volume.rst + audio/shell/bap.rst + audio/shell/bap_broadcast_assistant.rst + audio/shell/bap_scan_delegator.rst + audio/shell/cap.rst + audio/shell/ccp.rst + audio/shell/csip.rst + audio/shell/gmap.rst + audio/shell/mcp.rst + audio/shell/tmap.rst + audio/shell/pbp.rst Bluetooth LE Host ================= @@ -46,6 +45,7 @@ Bluetooth LE Host services.rst gap.rst + shell/iso.rst gatt.rst att.rst diff --git a/doc/connectivity/bluetooth/index.rst b/doc/connectivity/bluetooth/index.rst index c4f43563e6d..05e6ff410f7 100644 --- a/doc/connectivity/bluetooth/index.rst +++ b/doc/connectivity/bluetooth/index.rst @@ -17,7 +17,7 @@ hardware, as well as portions of a Classical Bluetooth (BR/EDR) Host layer. bluetooth-qual.rst bluetooth-arch.rst bluetooth-le-host.rst - bluetooth-le-audio-arch.rst + api/audio/bluetooth-le-audio-arch.rst bluetooth-ctlr-arch.rst bluetooth-dev.rst api/index.rst