Skip to content

WIP: Use Uv for managing packages and Ruff for code formatter. (#534) #11

WIP: Use Uv for managing packages and Ruff for code formatter. (#534)

WIP: Use Uv for managing packages and Ruff for code formatter. (#534) #11

Workflow file for this run

name: Deploy Sphinx Documentation to GitHub Pages
on:
push:
branches:
- development # Adjust this to your default branch
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Install system packages
run: |
sudo add-apt-repository universe multiverse
sudo apt update && sudo apt install enchant-2 libffi-dev libssl-dev libxml2-dev libxslt1-dev gettext libfreetype-dev libjpeg-dev
- name: Install dependencies
run: |
pip install -r requirements.txt
pip install "Jinja2<3.1" "sphinx==5.0.*"
working-directory: doc
- name: Build documentation
run: make html
working-directory: doc # Adjust to your Sphinx docs directory
- name: Copy CNAME if it exists
run: |
if [ -f CNAME ]; then cp CNAME doc/_build/html/; fi
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc/_build/html