Skip to content

Merge pull request #32 from V33RU/dev #79

Merge pull request #32 from V33RU/dev

Merge pull request #32 from V33RU/dev #79

Workflow file for this run

name: Deploy Docs
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
# Third-party actions pinned to commit SHAs (not moving tags).
# Dependabot (.github/dependabot.yml) bumps these on a schedule.
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
with:
fetch-depth: 0
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: '3.12'
cache: pip
- name: Install dependencies
# Hash-pinned. A hijacked PyPI release at any pinned version
# number will be rejected by --require-hashes.
run: pip install --require-hashes -r requirements-docs.txt
- name: Generate module docs (auto from modules/)
run: python3 scripts/gen_module_docs.py
- name: Build site
run: mkdocs build --site-dir _site
- uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
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@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5