Skip to content

Update README.md

Update README.md #44

Workflow file for this run

name: Build docs
on:
push:
branches:
- main
# These permissions are required for it to work
permissions:
contents: read
pages: write
id-token: write
jobs:
# build docs and upload
build:
strategy:
matrix:
python-version: [ 3.11 ]
os: [ ubuntu-latest ]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install '.[docs]'
- name: Build docs
run: |
mkdocs build
- name: Configure GitHub Pages
uses: actions/configure-pages@v5
- name: Upload docs
uses: actions/upload-pages-artifact@v3
with:
path: site # where `mkdocs build` puts the built site
# deployement job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.pages_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment # This is required for environment
uses: actions/deploy-pages@v4