Skip to content

feat: Support installation using pip #146

feat: Support installation using pip

feat: Support installation using pip #146

Workflow file for this run

name: Build documentation
on:
workflow_call:
inputs:
DOC_TAG:
required: true
type: string
pull_request:
paths:
- "ignis/**"
- "docs/**"
branches:
- '*'
jobs:
build:
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.12'
- name: Install Python dependencies
run: |
pip install -r docs/requirements.txt
- name: Build documentation
run: |
export DOC_TAG=${{ inputs.DOC_TAG }}
cd docs
make html
- name: Deploy to GitHub Pages
if: ${{ github.event_name != 'pull_request' }}
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
destination_dir: ${{ inputs.DOC_TAG }}
allow_empty_commit: true
force_orphan: false
keep_files: true