Generate doc #76
This file contains 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
| # 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://csukuangfj.github.io/kaldifeat | |
| name: Generate doc | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - doc | |
| workflow_dispatch: | |
| 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: Setup Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Display Python version | |
| run: python -c "import sys; print(sys.version)" | |
| - name: Update wheels | |
| shell: bash | |
| run: | | |
| export KALDIFEAT_DIR=$PWD | |
| ls -lh $KALDIFEAT_DIR | |
| export GIT_LFS_SKIP_SMUDGE=1 | |
| export GIT_CLONE_PROTECTION_ACTIVE=false | |
| git clone https://huggingface.co/csukuangfj/kaldifeat huggingface | |
| cd huggingface | |
| ./run.sh | |
| - name: Build doc | |
| shell: bash | |
| run: | | |
| cd doc | |
| git status | |
| python3 -m pip install -r ./requirements.txt | |
| make html | |
| cp source/cpu.html build/html/ | |
| cp source/cuda.html build/html/ | |
| cp source/cpu-cn.html build/html/ | |
| cp source/cuda-cn.html build/html/ | |
| touch build/html/.nojekyll | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./doc/build/html | |
| publish_branch: gh-pages |