Skip to content

Documentation

Documentation #43

name: Documentation
on:
workflow_dispatch:
push:
branches:
- master
paths:
- docs/**
- tycmd.py
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up PDM
uses: pdm-project/setup-pdm@v4
with:
cache: true
python-version: '3.10'
- name: Install dependencies
run: pdm sync -dG doc
- name: Sphinx build
run: pdm run sphinx-build docs/source docs/build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/
force_orphan: true