Skip to content

Merge pull request #352 from naik-aakash/ci_updates #180

Merge pull request #352 from naik-aakash/ci_updates

Merge pull request #352 from naik-aakash/ci_updates #180

Workflow file for this run

name: build-docs
on:
workflow_dispatch:
push:
branches: [ main ]
release:
types: [ published ]
# set GITHUB_TOKEN permissions to allow deployment to GitHub Pages
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[docs,featurizer]
- name: Sphinx build
run: |
sphinx-build docs _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true