Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Update README.md

Update README.md #2781

Workflow file for this run

name: Sphinx build
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.8
- name: Set Up Poetry
uses: abatilo/actions-poetry@v2
with:
poetry-version: 1.3.1
- name: Install dependencies
run: poetry install --sync -v
- name: Build HTML
run: poetry run sphinx-build -M html docs/source docs/build
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html