|
1 | | -# This workflow will upload a Python Package using Twine when a release is created |
2 | | -# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries |
3 | | - |
4 | | -# This workflow uses actions that are not certified by GitHub. |
5 | | -# They are provided by a third-party and are governed by |
6 | | -# separate terms of service, privacy policy, and support |
7 | | -# documentation. |
8 | | - |
9 | 1 | name: Build Docs |
10 | 2 |
|
11 | 3 | on: |
@@ -50,24 +42,31 @@ jobs: |
50 | 42 | submodules: recursive |
51 | 43 |
|
52 | 44 | - name: Install Package to Document |
53 | | - run: python -m pip install ${{ inputs.package_dir }}/ |
| 45 | + env: |
| 46 | + PACKAGE_DIR: ${{ inputs.package_dir }} |
| 47 | + run: python -m pip install "$PACKAGE_DIR/" |
54 | 48 |
|
55 | 49 | - name: Download ffi |
| 50 | + env: |
| 51 | + PACKAGE_NAME: ${{ inputs.package_name }} |
56 | 52 | run: | |
57 | | - if [[ '${{ inputs.package_name }}' = 'livekit.rtc' ]]; then |
| 53 | + if [[ "$PACKAGE_NAME" = 'livekit.rtc' ]]; then |
58 | 54 | pip install requests |
59 | | - python livekit-rtc/rust-sdks/download_ffi.py --output $(python -m site --user-site)/livekit/rtc/resources |
| 55 | + python livekit-rtc/rust-sdks/download_ffi.py --output "$(python -m site --user-site)/livekit/rtc/resources" |
60 | 56 | fi |
61 | 57 |
|
62 | 58 | - name: Install pdoc |
63 | 59 | run: pip install --upgrade pdoc |
64 | 60 |
|
65 | 61 | - name: Build Docs |
66 | | - run: python -m pdoc ${{ inputs.package_name }} --docformat=google --output-dir docs |
| 62 | + env: |
| 63 | + PACKAGE_NAME: ${{ inputs.package_name }} |
| 64 | + run: python -m pdoc "$PACKAGE_NAME" --docformat=google --output-dir docs |
67 | 65 |
|
68 | 66 | - name: S3 Upload |
69 | | - run: aws s3 cp docs/ s3://livekit-docs/${{ inputs.package_dir }} --recursive |
70 | 67 | env: |
| 68 | + PACKAGE_DIR: ${{ inputs.package_dir }} |
71 | 69 | AWS_ACCESS_KEY_ID: ${{ secrets.DOCS_DEPLOY_AWS_ACCESS_KEY }} |
72 | 70 | AWS_SECRET_ACCESS_KEY: ${{ secrets.DOCS_DEPLOY_AWS_API_SECRET }} |
73 | 71 | AWS_DEFAULT_REGION: "us-east-1" |
| 72 | + run: aws s3 cp docs/ "s3://livekit-docs/$PACKAGE_DIR" --recursive |
0 commit comments