Skip to content

Update README.md

Update README.md #6

Workflow file for this run

name: Docs
on: [push]
permissions:
contents: write
env:
APT_INSTALL: sudo apt-get install -y --no-install-recommends
jobs:
docs:
name: Docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
cache: pip
cache-dependency-path: pyproject.toml
python-version: 3.8
- name: Install dependencies
run: pip install -e ".[dev]"
- name: Install pandoc
run: $APT_INSTALL pandoc
- name: Sphinx build
run: sphinx-build docs/source docs/build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/
force_orphan: true