docs(build_recipes): add initial build recipes structure #91
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Quality check - Build docs | |
# PROCESS | |
# | |
# 1. Install all dependencies required to build the docs | |
# 2. Build the docs | |
# USAGE | |
# | |
# Always triggered on new PRs, PR changes and PR merge. | |
on: | |
pull_request: | |
paths: | |
- "docs/**" | |
- "examples/**" | |
- "mkdocs.yml" | |
branches: | |
- develop | |
push: | |
paths: | |
- "docs/**" | |
- "examples/**" | |
- "mkdocs.yml" | |
branches: | |
- develop | |
permissions: | |
contents: read | |
jobs: | |
build_docs: | |
runs-on: ubuntu-latest | |
permissions: | |
contents: read # checkout code only | |
steps: | |
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
- name: Set up Python | |
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
with: | |
python-version: 3.13 | |
- name: Install doc generation dependencies | |
run: | | |
cat docs/requirements.txt | |
pip install --require-hashes -r docs/requirements.txt | |
- name: Build docs | |
run: | | |
rm -rf site | |
mkdocs build |