mkdocs.yml

#** *****************************************************************************
# *
# * If not stated otherwise in this file or this component's LICENSE file the
# * following copyright and licenses apply:
# *
# * Copyright 2025 RDK Management
# *
# * Licensed under the Apache License, Version 2.0 (the "License");
# * you may not use this file except in compliance with the License.
# * You may obtain a copy of the License at
# *
# *
# * http://www.apache.org/licenses/LICENSE-2.0
# *
# * Unless required by applicable law or agreed to in writing, software
# * distributed under the License is distributed on an "AS IS" BASIS,
# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# * See the License for the specific language governing permissions and
# * limitations under the License.
# *
#** ******************************************************************************

site_name: RDK Hardware Porting Kit
site_url: https://www.github.com/rdkcentral/rdk-halif-aidl
site_dir: site # Site directory
docs_dir: docs

exclude_docs: |
  python_venv/
  scripts/
  external_content/*/.git/

plugins:
  - search
  - monorepo

repo_name: rdkcentral/rdk-halif-aidl
repo_url: https://github.com/rdkcentral/rdk-halif-aidl

nav:
  - Home: index.md
  - The Software Stack: introduction/the_software_stack.md
  - Hardware Abstraction Layer:
    - Introduction: introduction/aidl_and_binder.md
    - Key Concepts:
      - HAL Properties: key_concepts/hal/hal_properties.md
      - HAL Feature Profiles: key_concepts/hal/hal_feature_profiles.md
      - HAL Naming Conventions: key_concepts/hal/hal_naming_conventions.md
      - HAL Session State Management: key_concepts/hal/hal_session_state_management.md
      - HAL Resource Lifecycle: key_concepts/hal/hal_resource_lifecycle.md
      - HAL API Deprecation Governance: key_concepts/hal/hal_api_deprecation_governance.md
    - Standards:
      - Core Development Guide: standards/direct_branching.md
      - Fork-Based Contribution Guide: standards/forked_based_branching.md
      - Git Flow Branching Strategy: standards/git_flow_branching_strategy.md
      - Semantic Versioning: standards/semantic_versioning.md
      - AIDL Versioning Guide: standards/versioning-guide.md
      - Third-Party Build Integration: standards/build_integration.md
  - Vendor HAL Interfaces (VHI):
    - Overview: key_concepts/hal/hal_interfaces.md
    - Interface Generation: introduction/interface_generation.md
    - AV Subsystem:
      - Audio Decoder:
        - Current: '!include audiodecoder/current/mkdocs.yml'
        - 0.2.0.0: '!include audiodecoder/0.2.0.0/mkdocs.yml'
        - 0.1.0.0: '!include audiodecoder/0.1.0.0/mkdocs.yml'
      - Audio Mixer:
        - Current: '!include audiomixer/current/mkdocs.yml'
        - 0.3.0.0: '!include audiomixer/0.3.0.0/mkdocs.yml'
        - 0.2.0.0: '!include audiomixer/0.2.0.0/mkdocs.yml'
        - 0.1.0.1: '!include audiomixer/0.1.0.1/mkdocs.yml'
      - Audio Sink:
        - Current: '!include audiosink/current/mkdocs.yml'
        - 0.2.0.0: '!include audiosink/0.2.0.0/mkdocs.yml'
        - 0.1.0.0: '!include audiosink/0.1.0.0/mkdocs.yml'
      - AV Buffer:
        - Current: '!include avbuffer/current/mkdocs.yml'
        - 0.2.0.0: '!include avbuffer/0.2.0.0/mkdocs.yml'
        - 0.1.0.0: '!include avbuffer/0.1.0.0/mkdocs.yml'
      - AV Clock:
        - Current: '!include avclock/current/mkdocs.yml'
        - 0.2.0.1: '!include avclock/0.2.0.1/mkdocs.yml'
        - 0.2.0.0: '!include avclock/0.2.0.0/mkdocs.yml'
        - 0.1.0.0: '!include avclock/0.1.0.0/mkdocs.yml'
      - Video Decoder:
        - Current: '!include videodecoder/current/mkdocs.yml'
        - 0.2.0.1: '!include videodecoder/0.2.0.1/mkdocs.yml'
        - 0.2.0.0: '!include videodecoder/0.2.0.0/mkdocs.yml'
        - 0.1.0.0: '!include videodecoder/0.1.0.0/mkdocs.yml'
      - Video Sink:
        - Current: '!include videosink/current/mkdocs.yml'
        - 0.2.0.0: '!include videosink/0.2.0.0/mkdocs.yml'
        - 0.1.0.0: '!include videosink/0.1.0.0/mkdocs.yml'
    - Boot Reason:
      - Current: '!include bootreason/current/mkdocs.yml'
      - 0.1.0.0: '!include bootreason/0.1.0.0/mkdocs.yml'
    - Broadcast: '!include broadcast/current/mkdocs.yml'
    - DRM: '!include drm/current/mkdocs.yml'
    - HDMI:
      - HDMI CEC: '!include hdmicec/current/mkdocs.yml'
      - HDMI Input: '!include hdmiinput/current/mkdocs.yml'
      - HDMI Output: '!include hdmioutput/current/mkdocs.yml'
    - Common:
      - Current: '!include common/current/mkdocs.yml'
      - 0.2.0.0: '!include common/0.2.0.0/mkdocs.yml'
      - 0.1.0.0: '!include common/0.1.0.0/mkdocs.yml'
    - Composite Input: '!include compositeinput/current/mkdocs.yml'
    - Deep Sleep: '!include deepsleep/current/mkdocs.yml'
    - Device Info: '!include deviceinfo/current/mkdocs.yml'
    - Firmware Update:
      - Current: '!include firmwareupdate/current/mkdocs.yml'
      - 0.2.0.0: '!include firmwareupdate/0.2.0.0/mkdocs.yml'
    - Indicator: '!include indicator/current/mkdocs.yml'
    - Panel: '!include panel/current/mkdocs.yml'
    - Plane Control:
      - Current: '!include planecontrol/current/mkdocs.yml'
      - 0.2.0.0: '!include planecontrol/0.2.0.0/mkdocs.yml'
    - Sensor:
      - Current: '!include sensor/current/mkdocs.yml'
      - 0.2.0.0: '!include sensor/0.2.0.0/mkdocs.yml'
      - 0.1.0.0: '!include sensor/0.1.0.0/mkdocs.yml'
  - Vendor System Interfaces (VSI):
    - File System: '!include vsi/filesystem/current/mkdocs.yml'
    - Bluetooth: '!include vsi/bluetooth/current/mkdocs.yml'
    - Graphics: '!include vsi/graphics/current/mkdocs.yml'
    - Service Manager: vsi/service_manager/current/service_manager.md
    - Module Boot Sequence: vsi/boot_sequence/current/module_boot_sequence.md
    - Wi-Fi: '!include vsi/wifi/current/mkdocs.yml'
    - Systemd: vsi/systemd/current/systemd.md
    - Kernel: '!include vsi/kernel/current/mkdocs.yml'
    - Linux Input: '!include vsi/linuxinput/current/mkdocs.yml'
  - Transformation Guides:
    - Westeros onto IGraphicsFbProvider: transformation/westeros_graphics_fb_transform.md
  - Vendor Tests Suites (VTS):
    - Levels of Test: external_content/ut-core-wiki/3.-Standards:-Levels-of-Test-for-Vendor-Layer.md
    - Level 4:
      - L4 System Interface (VSI): external_content/ut-core-wiki/3.3.-Standards:-L4-‐-System-Interface-Testing.md
      - L4 Smoke Test (VST): external_content/ut-core-wiki/3.4.-Standards:-L4:-Vendor-Full-Stack-‐-Video-‐-Smoke-Regression-Test.md
  - Testing Framework:
    - Framework Usage: external_content/ut-core-wiki/3.2.-Standards:-Requirements-for-building-testing-suites.md
    - Key Concepts:
      - Test Driven Development: external_content/ut-core-wiki/3.1.-Standards:-Overview-of-Test‐Driven-Development.md
      - Black Box Testing: external_content/ut-core-wiki/FAQ:-Black‐Box-Testing-and-Code-Coverage-Metrics.md
      - Feedback Loops: external_content/ut-core-wiki/3.0.1-Standards:-Testing-Feedback-Loops.md
    - UT-Core Test Framework:
      - UT-Core Overview: external_content/ut-core-wiki/Home.md
      - Level Actors: external_content/ut-core-wiki/FAQ:-UT-Core-Framework-Overview.md
  - Virtual Device:
    - What is the vDevice: external_content/ut-core-wiki/5.0:-Standards:-vDevice-Overview.md
    - Architecture Overview: external_content/ut-core-wiki/5.0.1:-Standards:-vDevice-Architecture-Overview.md
    - Key Concepts:
      - Controller: external_content/ut-core-wiki/5.1.0:-Standards:-vDevice-Controller.md
      - Control Plane: external_content/ut-core-wiki/5.1.1:-Standards:-vDevice-Control-Plane.md
  - Misc:
    - References: references/references.md
    - Documentation Standards:
      - Getting Started: introduction/documentation_getting_started.md
      - Interface Template: standards/interface_template.md
    - Governance:
      - RDK Documentation Structure: governance/rdk-release-documentation-structure.md
      - RDK Engineering Validation Framework: governance/rdk-engineering-validation-framework.md
      - HAL Delivery & Versioning SOP: governance/versioning-sop.md
    - White Papers:
      - Documentation in Git: whitepapers/documentation_in_git.md
      - Branching Strategies : whitepapers/branching_strategies.md
      - Doxygen Code Documentation: whitepapers/doxygen_code_documentation.md
      - Achieving Engineering Goal: whitepapers/engineering_goals.md
      - Commit Message Standards: whitepapers/standardizing_git_commit_messages.md
      - Interface Version Alignment: whitepapers/interface_version_alignment.md
      - Client Usage of Stable AIDL: whitepapers/client_usage_of_stable_aidl.md
      - Right Format for the Right Job: whitepapers/right_format_right_job.md
    - Filing an Issue: external_content/ut-core-wiki/1.2.-Standards:-Issue-Description-Guideline.md
    - FAQ:
      - Python Development: external_content/ut-core-wiki/FAQ:-Comparing-Python-Development-Platforms.md
    - Release Notes:
      - 0.20.0: releases/0.20.0.md
      - 0.15.1: releases/0.15.1.md
      - 0.15.0: releases/0.15.0.md
      - 0.14.0: releases/0.14.0.md
    - ChangeLog: CHANGELOG.md

markdown_extensions:
  - admonition
  - def_list
  - footnotes
  - abbr
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - toc:
      toc_depth: 4
  - pymdownx.emoji: # Enable Extended Emoji if required
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences: # Enable mermaid
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra_css:
  - stylesheets/extra.css  # Ensure this file exists
#  - stylesheets/version.css

extra:
  version:
    provider: mike # This enables mike integration for the version selector

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/mermaid/11.4.1/mermaid.min.js
  - javascript/mermaid-init.js

theme:
  name: material
  features:
    - navigation.footer
    - navigation.sections
    - navigation.top
    - navigation.tracking
    #- navigation.tabs
    - navigation.instant  # New feature
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - content.tooltips  # New feature  icon:
    - content.print.stylesheet
    - search.highlight
    - search.suggest
    - search.share
    - header.autohide
    - announce.dismiss
  repo: fontawesome/brands/github
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode