Skip to content

Merge pull request #95 from imedslab/update-docs #5

Merge pull request #95 from imedslab/update-docs

Merge pull request #95 from imedslab/update-docs #5

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches:
- master
paths:
- 'doc/**'
jobs:
build-deploy-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install Pandoc
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx_rtd_theme nbsphinx nbsphinx_link
pip install .
- name: Build documentation
working-directory: doc
run: make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/build/html
publish_branch: gh-pages
force_orphan: true
user_name: "GitHub Actions"
user_email: "github-actions[bot]@users.noreply.github.com"
commit_message: "Deploy documentation for ${{ github.sha }}"