Skip to content
Publish docs

Publish docs/guide as GitHub Pages with MkDocs Material (#402) #1

Sign in to view logs

Publish docs/guide as GitHub Pages with MkDocs Material (#402)

Publish docs/guide as GitHub Pages with MkDocs Material (#402) #1

Workflow file for this run

.github/workflows/docs.yml at 2fba896
name: Publish docs
on:
push:
branches: [main]
paths:
- 'docs/guide/**'
- 'mkdocs.yml'
- 'docs/requirements.txt'
- '.github/workflows/docs.yml'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.12'
cache: pip
cache-dependency-path: docs/requirements.txt
- run: pip install -r docs/requirements.txt
- run: mkdocs build --strict
- uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4