2022-01-23 10:14:52 +00:00
|
|
|
name: Build documentation
|
|
|
|
|
|
|
|
on:
|
|
|
|
workflow_dispatch:
|
|
|
|
release:
|
|
|
|
types: [published]
|
|
|
|
|
|
|
|
jobs:
|
|
|
|
build:
|
|
|
|
runs-on: ubuntu-latest
|
2022-02-26 10:35:09 +00:00
|
|
|
strategy:
|
|
|
|
matrix:
|
2022-02-26 10:35:45 +00:00
|
|
|
python-version: ['^3.10']
|
2022-01-23 10:14:52 +00:00
|
|
|
|
|
|
|
steps:
|
|
|
|
- uses: actions/checkout@v2
|
|
|
|
|
|
|
|
- name: Set up Python ${{ matrix.python-version }}
|
|
|
|
uses: actions/setup-python@v2
|
|
|
|
with:
|
2022-02-26 10:35:09 +00:00
|
|
|
python-version: ${{ matrix.python-version }}
|
2022-01-23 10:14:52 +00:00
|
|
|
|
|
|
|
- name: Install dependencies
|
|
|
|
run: |
|
|
|
|
python -m pip install --upgrade pip
|
|
|
|
pip install pdoc
|
|
|
|
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
|
|
|
|
|
|
|
|
- name: Build docs
|
|
|
|
run: |
|
|
|
|
chmod +x ./scripts/build_documentation.sh
|
|
|
|
bash ./scripts/build_documentation.sh
|
|
|
|
|
|
|
|
- name: Deploy
|
|
|
|
uses: JamesIves/github-pages-deploy-action@4.1.4
|
|
|
|
with:
|
|
|
|
branch: documentation
|
2022-02-26 10:34:16 +00:00
|
|
|
folder: ./documentation
|