Renovate: actions/checkout to 11bd719 #47
Workflow file for this run
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: Documentation | |
on: | |
push: | |
branches: | |
- main | |
pull_request: | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout source | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 | |
- name: Cache tox | |
uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4 | |
with: | |
path: .tox | |
key: tox-${{ hashFiles('pyproject.toml') }} | |
- name: Set up Python | |
uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5 | |
with: | |
python-version: "3.x" | |
cache: "pip" | |
cache-dependency-path: "pyproject.toml" | |
- name: Install tox | |
run: python -m pip install tox | |
- name: Build HTML documentation with tox | |
run: tox -e docs | |
# Automatically deploy documentation to a GitHub Pages website on pushing to main. | |
# Requires configuring the repository to deploy GitHub pages from a branch | |
# gh-pages (https://tinyurl.com/gh-pages-from-branch), which will be created the | |
# first time this workflow step is run. | |
- name: Publish documentation on GitHub pages | |
if: success() && github.event_name != 'pull_request' | |
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: site | |
publish_branch: gh-pages | |
user_name: "github-actions[bot]" | |
user_email: "github-actions[bot]@users.noreply.github.com" |