docs: migrate from Sphinx to mkdocs material #2
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: Docs | |
| on: | |
| pull_request: | |
| paths: | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - "AGENTS.md" | |
| - "redisvl/**/*.py" | |
| - "pyproject.toml" | |
| - "uv.lock" | |
| - ".readthedocs.yaml" | |
| - ".github/workflows/docs.yml" | |
| push: | |
| branches: | |
| - main | |
| env: | |
| UV_VERSION: "0.7.13" | |
| jobs: | |
| build: | |
| name: mkdocs build --strict | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: "3.11" | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v6 | |
| with: | |
| version: ${{ env.UV_VERSION }} | |
| enable-cache: true | |
| python-version: "3.11" | |
| cache-dependency-glob: | | |
| pyproject.toml | |
| uv.lock | |
| - name: Install docs dependencies | |
| run: uv sync --frozen --group docs | |
| - name: Build docs (strict) | |
| env: | |
| DISABLE_MKDOCS_2_WARNING: "true" | |
| run: uv run mkdocs build --strict | |
| - name: Upload built site | |
| if: always() | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: site | |
| path: site/ | |
| retention-days: 7 |