Merge pull request #81 from dskrypa/dev #306
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 | |
permissions: read-all # Declare default permissions as read only. | |
on: | |
push: | |
branches: ["main"] | |
paths: ["lib/**", "docs/**", "examples/**"] | |
workflow_dispatch: {} | |
jobs: | |
build: | |
runs-on: ["ubuntu-latest"] | |
permissions: | |
contents: write | |
strategy: | |
fail-fast: false | |
matrix: | |
python-version: ["3.13"] | |
steps: | |
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip setuptools wheel | |
pip install -e . -r docs/requirements.txt | |
- name: Generate docs | |
run: python bin/build_docs.py -cu | |
- name: GitHub Pages action | |
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/ |