Skip to content

ruff linting

ruff linting #9

name: "Sphinx: Render docs"
on:
# Triggers the workflow on push or pull request events but only for the main branch
push:
branches: [ main]
pull_request:
branches: [ main ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- uses: actions/checkout@v4
- name: Install sphinx and build documentation with sphinx
run: |
python --version
pip install sphinx sphinx_rtd_theme sphinxcontrib-email
pip install -e .
cd docs
make html
- 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