build-doc.yml

# Copyright      2022  Xiaomi Corp.       (author: Fangjun Kuang)

# See ../../LICENSE for clarification regarding multiple authors
#
# 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.

# refer to https://github.com/actions/starter-workflows/pull/47/files

# You can access it at https://k2-fsa.github.io/sherpa/
name: Generate doc
on:
  push:
    branches:
      - master
      - doc
    paths:
      - '.github/workflows/build-doc.yml'
      - 'docs/**'

  workflow_dispatch:

concurrency:
  group: build-doc-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build-doc:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
        python-version: [3.8]
    steps:
      # refer to https://github.com/actions/checkout
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Run docker
        uses: addnab/docker-run-action@v3
        with:
            image: reitzig/texlive-full:latest
            # image: ghcr.io/xu-cheng/texlive-full:latest
            options: |
              --volume ${{ github.workspace }}/:/workspace
            shell: bash
            run: |
              uname -a
              cat /etc/*release

              id
              pwd
              ls -lh

              cd /workspace
              which latexmk

              apk add --no-cache python3 py3-pip git make gcc zlib-dev libffi-dev openssl-dev musl-dev ghostscript
              python3 --version


              python3 -m venv abc
              source ./abc/bin/activate
              python3 -m ensurepip

              python3 -m pip install -r ./docs/requirements.txt

              cd docs
              make html
              touch build/html/.nojekyll

              export GIT_LFS_SKIP_SMUDGE=1
              git clone https://huggingface.co/csukuangfj/sherpa-onnx-apk huggingface
              cd huggingface
              ./generate-tts.py
              ./generate-tts-engine.py
              ./generate-speaker-identification.py
              mv -v apk.html ../build/html/onnx/tts/
              mv -v apk-engine.html ../build/html/onnx/tts/
              mv -v apk-speaker-identification.html ../build/html/onnx/speaker-identification/apk.html
              cd ..
              rm -rf huggingface

              git clone https://huggingface.co/csukuangfj/sherpa huggingface
              cd huggingface
              ./run.sh
              cp cpu.html ../build/html
              cp cuda.html ../build/html
              cd ..
              rm -rf huggingface

              make latex
              mkdir -pv build/html/_static
              cd build/latex
              latexmk -interaction=nonstopmode -f -pdf -dvi- -ps- sherpa.tex || true
              ls -lh sherpa.pdf
              cp -v sherpa.pdf ../html/

      - name: Release sherpa.pdf
        if: (github.repository_owner == 'csukuangfj' || github.repository_owner == 'k2-fsa') && github.event_name == 'push'
        uses: svenstaro/upload-release-action@v2
        with:
          file_glob: true
          overwrite: true
          file: ./docs/build/html/sherpa.pdf
          tag: doc

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/build/html
          publish_branch: gh-pages