Skip to content

Update actions/checkout action to v4 (#67) #59

Update actions/checkout action to v4 (#67)

Update actions/checkout action to v4 (#67) #59

Workflow file for this run

name: Documentation
on:
push:
branches:
- main
jobs:
documentation:
runs-on: ubuntu-latest
steps:
- name: checkout source
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
- name: Set up python
uses: actions/setup-python@v4
with:
python-version: "3.x"
cache: "pip"
cache-dependency-path: "pyproject.toml"
- name: Install dependencies
run: python -m pip install -e .[docs]
- name: Create documentation
run: pdoc --html src/example
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./html/example
publish_branch: gh-pages
user_name: "github-actions[bot]"
user_email: "github-actions[bot]@users.noreply.github.com"