Skip to content

Commit 386d85b

Browse files
committed
Documentation workflow
1 parent 7e499dd commit 386d85b

File tree

7 files changed

+35
-0
lines changed

7 files changed

+35
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Docs
2+
on:
3+
workflow_dispatch:
4+
push:
5+
branches:
6+
- master
7+
- documentation
8+
paths:
9+
- '.github/workflows/documentation.yaml'
10+
- 'docs/**'
11+
- 'alyx/alyx/__init__.py'
12+
- 'CHANGELOG.md'
13+
- 'README.md'
14+
- 'pyproject.toml'
15+
permissions:
16+
contents: write
17+
jobs:
18+
docs:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
- name: Install dependencies
23+
run: |
24+
python -m pip install --upgrade pip
25+
pip install -r requirements.txt
26+
pip install -r docs/requirements.txt
27+
- name: Sphinx build
28+
run: sphinx-build docs/source docs/build/html
29+
- name: Deploy
30+
uses: peaceiris/actions-gh-pages@v3
31+
with:
32+
publish_branch: gh-pages
33+
github_token: ${{ secrets.GITHUB_TOKEN }}
34+
publish_dir: docs/build/html
35+
force_orphan: true
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)