Skip to content

update README

update README #7

Workflow file for this run

name: Docs
on:
pull_request:
branches: ['main']
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
cache: pip
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r docs/requirements.txt
python3 -m pip install -e .
- name: Build docs
run: |
sphinx-build -W -b html docs/ docs/build/html