Skip to content

Mkdocs hosting

Mkdocs hosting #1

Workflow file for this run

name: Docs
on:
push:
branches: [main]
paths:
- "mkdocs.yml"
- "requirements-docs.txt"
- "docs/**"
- "api-usage-docs/**"
- "tutorials/**"
- "products/**"
pull_request:
paths:
- "mkdocs.yml"
- "requirements-docs.txt"
- "docs/**"
- "api-usage-docs/**"
- "tutorials/**"
- "products/**"
workflow_dispatch:
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.x"
- run: pip install -r requirements-docs.txt
- run: mkdocs build --strict
- uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
needs: build
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/configure-pages@v5
- uses: actions/deploy-pages@v4
id: deployment