Skip to content

fix docs workflow

fix docs workflow #248

Workflow file for this run

name: "Documentation"
on:
push:
branches:
- develop
paths:
- 'docs/**'
- 'mkdocs.yaml'
- '.github/workflows/docs.yml'
pull_request:
branches:
- develop
types:
- opened
- synchronize
paths:
- 'docs/**'
- 'mkdocs.yaml'
- '.github/workflows/docs.yml'
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
changes:
runs-on: ubuntu-latest
timeout-minutes: 1
defaults:
run:
shell: bash
outputs:
docs: ${{ steps.changed_files.outputs.docs }}
steps:
- name: Checkout code
uses: actions/checkout@v7
- id: changed_files
name: Check for file changes
uses: dorny/paths-filter@v4
with:
base: ${{ github.ref }}
token: ${{ github.token }}
filters: .github/file-filters.yml
generate:
name: Generate
if: needs.changes.outputs.docs == 'true'
needs: changes
runs-on: ubuntu-latest
env:
PYTHONPATH: src/
steps:
- uses: actions/checkout@v7
- uses: actions/setup-python@v6
with:
python-version: '3.12'
- run: pip install tox
- name: Check Python Package structure
run: tox -e docs -- -d docs-output
- name: Upload artifact
uses: actions/upload-pages-artifact@v5
with:
path: ./docs-output
# Deployment job
deploy:
needs: generate
if: github.event_name == 'push' && github.ref == 'refs/heads/develop'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5