Skip to content
Build Docs

Build Docs #8

Sign in to view logs

Build Docs

Build Docs #8

Workflow file for this run

.github/workflows/build-docs.yml at f20b832
# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
name: Build Docs
on:
workflow_dispatch:
inputs:
package_dir:
required: true
type: string
package_name:
required: true
type: string
workflow_call:
inputs:
package_dir:
required: true
type: string
package_name:
required: true
type: string
secrets:
PYPI_API_TOKEN:
required: true
DOCS_DEPLOY_AWS_ACCESS_KEY:
required: true
DOCS_DEPLOY_AWS_API_SECRET:
required: true
permissions:
contents: read
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: recursive
- name: Virtual Env
run: python -m venv venv
- name: Source Virtual Env
run: source venv/bin/activate
- name: Log Env
run: env
- name: Install Package to Document
run: venv/bin/python -m pip install ${{ inputs.package_dir }}/
- name: Install pdoc
run: venv/bin/python -m pip install --upgrade pdoc
- name: Build Docs
run: venv/bin/python -m pdoc ${{ inputs.package_name }} --docformat=google --output-dir docs
- name: S3 Upload
run: aws s3 cp docs/ s3://livekit-docs/${{ inputs.package_dir }} --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"