Skip to content

docs: product name and fix code examples #3

docs: product name and fix code examples

docs: product name and fix code examples #3

Workflow file for this run

name: Docs
on:
push:
branches: ["master"]
workflow_dispatch:
permissions:
contents: write
jobs:
deploy-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install docs deps
run: |
python -m pip install --upgrade pip
pip install mkdocs-material
if [ -f requirements-docs.txt ]; then pip install -r requirements-docs.txt; fi
- name: Configure git (gh-deploy)
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
- name: Deploy to gh-pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: mkdocs gh-deploy --force --remote-branch gh-pages