Merge pull request #10 from int-brain-lab/develop #25
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: | |
workflow_dispatch: | |
push: | |
branches: | |
- main | |
paths: | |
- '.github/workflows/documentation.yaml' | |
- 'docs/**' | |
- 'iblqt/**' | |
permissions: | |
contents: write | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: pdm-project/setup-pdm@v4 | |
with: | |
cache: true | |
python-version: '3.10' | |
- name: Install dependencies | |
run: pdm install -dG doc | |
- name: Install PyQt5 | |
run: pdm add PyQt5 | |
- name: Sphinx build | |
run: pdm run sphinx-build docs/source docs/build | |
- uses: peaceiris/actions-gh-pages@v4 | |
with: | |
publish_branch: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/build/ | |
force_orphan: true |