Repository navigation
doc: add subsystem C API reference pages with Breathe and modernize root portal - #539
Merged
lgirdwood merged 2 commits intoOct 11, 2026
Conversation
Integrate Sound Open Firmware C API reference documentation directly into Sphinx using Breathe groups: - api/ipc4.rst: Host-DSP IPC4 protocol structures and commands - api/modules.rst: Loadable module and LLEXT interfaces - api/pipeline.rst: Audio pipeline execution, scheduling, and buffers - api/components.rst: Built-in audio processing components - api/rtos.rst: RTOS abstraction layer and synchronization primitives - api/math.rst: DSP mathematics and filter libraries Update api/index.rst with subpage navigation to ensure all C API symbols and data structures are fully indexed and searchable. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
Replace the bare redirect stub on index.rst with a comprehensive technical documentation portal. Add project architecture overview, high-level capability summary, and interactive navigation cards for all eight documentation pillars (Introduction, Getting Started, Architecture, Platforms, Algorithms, Developer Guides, C API, and Contributing). Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
lgirdwood
requested review from
deb-intel,
intelkevinputnam,
mmaka1 and
mwasko
as code owners
October 11, 2026 20:44
lgirdwood
force-pushed
the
topic/doxygen-c-api-architecture
branch
from
October 11, 2026 20:56
5fd6090 to
5dc99b8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request accompanies the Sound Open Firmware C API architecture documentation overhaul in thesofproject/sof#11294:
Subsystem C API Reference Pages (
api/):api/ipc4.rst: Host-DSP IPC4 protocol structures and commands (ipc4_api)api/modules.rst: Loadable module and LLEXT interfaces (module_api)api/pipeline.rst: Audio pipeline execution, scheduling, and buffers (audio_pipeline_api)api/components.rst: Built-in audio processing components (audio_components_api)api/rtos.rst: RTOS abstraction layer and synchronization primitives (rtos_api)api/math.rst: DSP mathematics and filter libraries (dsp_math_api)api/index.rstwith subpage navigation and a direct link to the full raw Doxygen interactive documentation portal.Root Documentation Portal (
index.rst):Signed-off-by: Liam Girdwood liam.r.girdwood@linux.intel.com