Skip to content

Update README links

Update README links #4

name: Docs
on:
workflow_dispatch:
push:
branches:
- master
- documentation
paths:
- '.github/workflows/documentation.yaml'
- 'docs/**'
- 'alyx/alyx/__init__.py'
- 'CHANGELOG.md'
- 'README.md'
- 'pyproject.toml'
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r docs/requirements.txt
- name: Sphinx build
run: sphinx-build docs/source docs/build/html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html
force_orphan: true