Skip to content

Deploy Sphinx docs to GitHub Pages #1

Deploy Sphinx docs to GitHub Pages

Deploy Sphinx docs to GitHub Pages #1

Workflow file for this run

name: Deploy Sphinx docs to GitHub Pages
on:
push:
branches:
- main
workflow_dispatch:
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt sphinx
- name: Build Sphinx HTML
run: sphinx-build -b html docs docs/_build/html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html