Skip to content

Added Sphinx doc (#10) #1

Added Sphinx doc (#10)

Added Sphinx doc (#10) #1

Workflow file for this run

name: Deploy docs
on:
push:
branches: [ main ]
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Install Poetry
run: python -m pip install --upgrade pip && pip install poetry
- name: Install project dependencies (including docs)
run: POETRY_VIRTUALENVS_CREATE=false poetry install --no-interaction --with doc
- name: Build Sphinx docs
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