Skip to content

Merge pull request #25 from xsuite/release/v0.4.2 #2

Merge pull request #25 from xsuite/release/v0.4.2

Merge pull request #25 from xsuite/release/v0.4.2 #2

Workflow file for this run

name: Build and Deploy Docs
on:
push:
branches: [ main ]
workflow_dispatch:
permissions:
contents: write # required for pushing to gh-pages
concurrency:
group: "docs-deploy"
cancel-in-progress: true
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
# 1. Checkout repo
- name: Checkout repository
uses: actions/checkout@v4
# 2. Set up Python
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
# 3. Install dependencies
- name: Install dependencies
working-directory: docs
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
# 4. Build HTML docs
- name: Build HTML documentation
working-directory: docs
run: |
make clean
make html
# 5. Deploy to GitHub Pages (gh-pages branch)
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html
enable_jekyll: false