Feat/api embeddings #1159
Workflow file for this run
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
| name: Build and Publish Multi-Version Docs | |
| on: | |
| push: | |
| branches: | |
| - dev | |
| release: | |
| types: | |
| - published | |
| pull_request: | |
| branches: | |
| - dev | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: ${{ github.ref != 'refs/heads/dev' }} | |
| permissions: | |
| contents: write | |
| jobs: | |
| build-docs: | |
| name: Build Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| fetch-tags: true | |
| - name: Cache Hugging Face | |
| id: cache-hf | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/huggingface | |
| key: docs-cache-hf | |
| - name: Install pandoc | |
| run: | | |
| sudo apt install pandoc | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v6 | |
| with: | |
| version: "0.8.8" | |
| - name: Install dependencies | |
| run: | | |
| uv sync --group docs | |
| - name: Run tests | |
| if: github.event_name != 'workflow_dispatch' | |
| run: | | |
| echo "Testing documentation build..." | |
| make test-docs | |
| - name: Build documentation | |
| if: ${{ github.ref == 'refs/heads/dev' }} && github.event_name != 'workflow_dispatch' | |
| run: | | |
| make docs | |
| - name: build multiversion documentation | |
| if: github.event_name == 'release' || github.event_name == 'workflow_dispatch' | |
| run: | | |
| make multi-version-docs | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: github.event_name == 'release' || github.event_name == 'workflow_dispatch' | |
| with: | |
| github_token: ${{ github.token }} | |
| publish_dir: docs/build/html/versions | |
| destination_dir: versions | |
| keep_files: true |