Skip to content

ci: update MkDocs workflow environment variable and refine dependenci… #3

ci: update MkDocs workflow environment variable and refine dependenci…

ci: update MkDocs workflow environment variable and refine dependenci… #3

Workflow file for this run

name: Docs (MkDocs)
on:
push:
branches: ["main"]
paths:
- "docs/**"
- "mkdocs.yml"
- "requirements-docs.txt"
- ".github/workflows/docs-gh-pages.yml"
workflow_dispatch:
permissions:
contents: write
concurrency:
group: docs-gh-pages
cancel-in-progress: true
jobs:
deploy:
runs-on: ubuntu-latest
env:
NO_MKDOCS_2_WARNING: "1"
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: "pip"
cache-dependency-path: "requirements-docs.txt"
- name: Install MkDocs
run: |
python -m pip install --upgrade pip
pip install -r requirements-docs.txt
- name: Build docs
run: mkdocs build --strict
- name: Deploy to gh-pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: mkdocs gh-deploy --force --clean --verbose