Skip to content

Commit

Permalink
iter
Browse files Browse the repository at this point in the history
  • Loading branch information
keepingitneil committed Jan 12, 2024
1 parent d3f75bc commit 75d0759
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ jobs:
uses: ./.github/workflows/build-docs.yml
with:
package_dir: "livekit-api"
docs_entrypoint: "livekit-api/livekit/api"
package_name: "livekit.api"
secrets: inherit
5 changes: 3 additions & 2 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,15 @@ jobs:
- name: Install Package to Document
run: python -m pip install ${{ inputs.package_dir }}/

# Needed because we don't build the wheel to generate docs and importing livekit.rtc will look for the ffi
- name: Download ffi
run: pip install requests && python livekit-rtc/rust-sdks/download_ffi.py --output $(python -m site --user-site)/livekit/rtc/resources
run: [[ ${{ inputs.package_name }} = 'livekit.rtc' ]] && pip install requests && python livekit-rtc/rust-sdks/download_ffi.py --output $(python -m site --user-site)/livekit/rtc/resources

- name: Install pdoc
run: pip install --upgrade pdoc

- name: Build Docs
run: python -m pdoc ${{ inputs.package_name }} --docformat=google --output-dir docs
run: 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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-protocol.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ jobs:
uses: ./.github/workflows/build-docs.yml
with:
package_dir: "livekit-protocol"
docs_entrypoint: "livekit-protocol/livekit/protocol"
package_name: "livekit.protocol"
secrets: inherit

0 comments on commit 75d0759

Please sign in to comment.