Skip to content

Update README.md

Update README.md #3595

Workflow file for this run

name: Documentation build
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
strategy:
max-parallel: 4
matrix:
python-version: ["3.9", "3.10", "3.11"]
steps:
- name: Checkout repo
uses: actions/checkout@v1
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
with:
python-version: ${{ matrix.python-version }}
- name: Install
run: |
python -m pip install --upgrade pip
pip install .[all]
sudo apt-get install -y xvfb
- name: Build docs
env:
XVFB: 1
DISPLAY: :99
run: |
Xvfb :99 -screen 0 1280x1024x24 &
cd docs
make html
- name: Upload docs
uses: actions/upload-artifact@v1
with:
name: docs
path: docs/build/html
- name: Publish docs to Github Pages
if: startsWith(github.event.ref, 'refs/tags')
uses: JamesIves/github-pages-deploy-action@releases/v3
with:
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: docs/build/html # The folder the action should deploy.