Skip to content

Update README.md

Update README.md #579

Workflow file for this run

name: docs
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
release:
types: [ published ]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install dependencies
run: |
sudo apt-get update -y
sudo apt-get install openjdk-11-jre-headless pandoc --fix-missing
python -m pip install --upgrade pip setuptools wheel
- name: Build Sphinx docs
run: |
docs/build_docs.sh
timeout-minutes: 10
- name: Deploy to gh-pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'release' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html