Skip to content

Merge pull request #94 from manuGil/docs/architecture #101

Merge pull request #94 from manuGil/docs/architecture

Merge pull request #94 from manuGil/docs/architecture #101

Workflow file for this run

name: deploy-docs
on:
push:
branches:
- main
- dev
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install Pandoc
uses: pandoc/actions/setup@v1
with:
version: 3.5
- name: Install dependencies
run: |
pip install pip --upgrade
pip install -r docs/requirements.txt
- name: Sphinx build
run: |
sphinx-build docs _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/dev' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true