Skip to content

Merge pull request #12 from gperdrizet/dev #27

Merge pull request #12 from gperdrizet/dev

Merge pull request #12 from gperdrizet/dev #27

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches: [ main ]
workflow_dispatch:
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-rtd-theme nbsphinx sphinx-autodoc-typehints
pip install -r requirements.txt
- name: Build documentation
run: |
cd docs
make html
touch build/html/.nojekyll
- name: Deploy to GitHub Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html