Skip to content

Update README.md

Update README.md #92

Workflow file for this run

name: doc
on:
push:
branches:
- main
workflow_dispatch:
jobs:
doc:
runs-on: ${{ matrix.platform }}
strategy:
max-parallel: 5
matrix:
platform: [ubuntu-latest]
python-version: [3.9]
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/[email protected]
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools wheel
python -m pip install poetry
poetry install
- run: poetry run make doc
- 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