Gupje/.github/workflows/deploy-docs.yml

42 lines
978 B
YAML
Raw Normal View History

2025-01-03 12:15:50 +01:00
name: Deploy Sphinx Docs to GitHub Pages
2025-01-03 18:32:14 +01:00
permissions:
contents: read
pages: write
id-token: write
2025-01-03 12:15:50 +01:00
on:
push:
branches:
- main # Adjust this if your default branch is not 'main'
jobs:
build-and-deploy:
runs-on: ubuntu-latest
2025-01-03 18:40:47 +01:00
permissions:
contents: write
2025-01-03 12:15:50 +01:00
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.12' # Specify the Python version you need
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx
pip install -r docs/requirements.txt # Adjust if you have additional requirements
- name: Build documentation
run: |
cd docs
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html