v0.6.3 #84
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: Docs | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| env: | |
| CARGO_TERM_COLOR: always | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Deps | |
| run: bash ./scripts/deps_ci.sh | |
| - name: Build vidformer docs | |
| run: cargo doc --no-deps -p vidformer | |
| - name: Install mdbook | |
| run: cargo install mdbook | |
| - name: Build docs | |
| run: pushd docs && mdbook build && popd && cp -r docs/book/* target/doc | |
| - name: Install vidformer-py # needed to import dependencies when building docs | |
| run: pip3 install ./vidformer-py | |
| - name: Install pdoc | |
| run: pip3 install pdoc | |
| - name: Build pdoc | |
| run: pushd vidformer-py/vidformer && pdoc vf.py -o ../../target/doc/vidformer-py && pdoc cv2/vf_cv2.py -o ../../target/doc/vidformer-py-cv2 && popd | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./target/doc | |
| publish_branch: gh-pages | |
| force_orphan: true | |
| user_name: 'github-actions[bot]' | |
| user_email: 'github-actions[bot]@users.noreply.github.com' | |
| commit_message: 'Deploy docs' |