Update doc generation workflow #23
Workflow file for this run
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
| name: Publish docs | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| lfs: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.12' # Specify the Python version you want to use | |
| - name: Create and activate virtual environment | |
| run: | | |
| python -m venv venv | |
| source venv/bin/activate | |
| - name: Install pdoc and other dependencies | |
| run: | | |
| source venv/bin/activate | |
| python -m pip install pdoc3 setuptools | |
| - name: Install package | |
| run: | | |
| source venv/bin/activate | |
| python -m pip install livekit \ | |
| livekit-protocol \ | |
| ./livekit-agents \ | |
| ./livekit-plugins/livekit-plugins-anthropic \ | |
| ./livekit-plugins/livekit-plugins-azure \ | |
| ./livekit-plugins/livekit-plugins-cartesia \ | |
| ./livekit-plugins/livekit-plugins-deepgram \ | |
| ./livekit-plugins/livekit-plugins-elevenlabs \ | |
| ./livekit-plugins/livekit-plugins-google \ | |
| ./livekit-plugins/livekit-plugins-nltk \ | |
| ./livekit-plugins/livekit-plugins-openai | |
| - name: Download ffi | |
| run: | | |
| source venv/bin/activate | |
| SITE_PACKAGES=$(python -c "import site; print(site.getsitepackages()[0])") | |
| git clone https://github.com/livekit/rust-sdks.git | |
| python -m pip install requests && python rust-sdks/download_ffi.py --output $SITE_PACKAGES/livekit/rtc/resources | |
| - name: Build Docs | |
| run: | | |
| source venv/bin/activate | |
| python -m pdoc --skip-errors --html livekit.rtc livekit.agents --output-dir docs | |
| - name: Remove Submodules | |
| run: | | |
| NON_MODULE_DIRS=$(find docs -type f -not -name index.html) | |
| INPUT_FILES=$(docs/**/index.html) | |
| sed '/<h2 class="section-title" id="header-submodules">Sub-modules<\/h2>/,/<\/section>/d' "$input_file" > "$output_file" | |
| rm -rf livekit-agents | |
| rm -rf livekit-plugins | |
| - name: S3 Upload | |
| run: | | |
| source venv/bin/activate | |
| aws s3 cp docs/ s3://livekit-docs/python --recursive | |
| env: | |
| AWS_ACCESS_KEY_ID: ${{ secrets.DOCS_DEPLOY_AWS_ACCESS_KEY }} | |
| AWS_SECRET_ACCESS_KEY: ${{ secrets.DOCS_DEPLOY_AWS_API_SECRET }} | |
| AWS_DEFAULT_REGION: "us-east-1" |