Add DepthConverter and enhance pre-processing capabilities #352
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
| --- | |
| # SPDX-FileCopyrightText: (C) 2025 Intel Corporation | |
| # SPDX-License-Identifier: MIT | |
| name: Documentation Check | |
| on: # yamllint disable-line rule:truthy | |
| pull_request: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| permissions: {} | |
| jobs: | |
| filter: | |
| permissions: | |
| contents: read # needed for actions/checkout | |
| runs-on: dlstreamer | |
| outputs: | |
| dlstreamer_documentation_changed: ${{ steps.filter.outputs.dlstreamer_documentation }} | |
| steps: | |
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| with: | |
| persist-credentials: false | |
| - name: Set paths filter | |
| id: filter | |
| uses: dorny/paths-filter@fbd0ab8f3e69293af611ebaee6363fc25e6d187d #4.01 | |
| with: | |
| filters: | | |
| dlstreamer_documentation: | |
| - 'docs/user-guide/**' | |
| build-dlstreamer-documentation: | |
| permissions: | |
| contents: read # needed for actions/checkout | |
| needs: filter | |
| if: ${{ needs.filter.outputs.dlstreamer_documentation_changed == 'true' }} | |
| runs-on: dlstreamer | |
| env: | |
| DOCS_DIR: . | |
| SIMPLE_MODE: true | |
| EXCLUDE_PATTERNS: "" | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| with: | |
| # Fetch all history, otherwise sporadic issue with missing tags | |
| fetch-depth: 0 | |
| # Fetch tags | |
| fetch-tags: true | |
| # Checkout the branch that triggered the workflow | |
| # to avoid detached HEAD | |
| ref: ${{ github.event.pull_request.head.sha || github.head_ref }} | |
| persist-credentials: false | |
| - name: Download template | |
| if: ${{ env.SIMPLE_MODE == 'true' }} | |
| shell: bash | |
| run: | | |
| cd "${GITHUB_WORKSPACE}/${DOCS_DIR}" | |
| wget https://docs.openedgeplatform.intel.com/template/template.tar.gz | |
| # Override any existing files with template | |
| tar xf template.tar.gz | |
| if [ -f "dictionary_append.txt" ]; then | |
| cat "dictionary_append.txt" >> "dict.txt" | |
| fi | |
| - name: Add exclude patterns | |
| shell: bash | |
| run: | | |
| # Remove any spaces | |
| exclude_no_spaces="${EXCLUDE_PATTERNS// /}" | |
| # Surround patterns with quotes and create Python list | |
| exclude_pattern="[\"${exclude_no_spaces//,/\", \"}\"]" | |
| conf_files=$(find "${GITHUB_WORKSPACE}" -type f -path "*/docs/conf.py") | |
| for conf_file in $conf_files; do | |
| echo "exclude_patterns.extend(${exclude_pattern})" >> "$conf_file" | |
| done | |
| - name: Build Documentation | |
| shell: bash | |
| run: | | |
| cd "${GITHUB_WORKSPACE}/${DOCS_DIR}" | |
| make build |