Skip to content

(docs) Add declarative yaml explanations #268

(docs) Add declarative yaml explanations

(docs) Add declarative yaml explanations #268

Workflow file for this run

name: "Client library: Documentation"
on:
push:
branches:
- main
pull_request:
paths:
- client/**
branches:
- main
permissions:
contents: write
jobs:
deploy-docs:
runs-on: ubuntu-latest
name: Deploy documentation to GitHub Pages
# publish on 'main' only to prevent version clutter
if: ${{ github.ref == 'refs/heads/main' }}
concurrency: docs
steps:
- uses: actions/checkout@v4
- name: Set up Python and dependencies
uses: ./.github/actions/python-deps
with:
pythonVersion: "3.12"
- name: Build pre-release documentation
run: uv run mkdocs build
- name: Archive built documentation
uses: actions/upload-artifact@v4
with:
name: docs
path: public/docs
- name: Deploy pre-release documentation
if: ${{ github.ref_name == 'main'}}
uses: ./.github/actions/mike-docs
with:
version: development
pre_release: true # include pre-release notification banner
push: true