python-template/.github/workflows/docs.yaml at main · python-project-templates/python-template · GitHub

Repository navigation

View runs

History

59 lines (50 loc) · 1.73 KB

Raw

name: Publish Docs

on:

workflow_run:

workflows: ["Build Status"]

branches: [main]

types: [completed]

workflow_dispatch:

permissions:

actions: read

contents: write

jobs:

docs:

runs-on: ubuntu-24.04

if: github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch'

steps:

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

persist-credentials: false

- name: Setup Python

uses: actions-ext/python/setup@c8228d827a81b9f8c808825328af361c45461ba3

- name: Download distributions

uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8

with:

pattern: dist

merge-multiple: true

path: dist

run-id: ${{ github.event.workflow_run.id }}

github-token: ${{ secrets.GITHUB_TOKEN }}

repository: ${{ github.repository }}

if: github.event_name == 'workflow_run'

- name: Install from wheel

run: |

uv pip install dist/*.whl

uv pip install dist/*.whl --target . --no-deps

uv pip install "yardang[themes]"

if: github.event_name == 'workflow_run'

- name: Install from source (manual trigger)

run: |

uv pip install .[develop]

uv pip install "yardang[themes]"

if: github.event_name == 'workflow_dispatch'

- name: Build documentation

run: yardang build

- name: Publish documentation

uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0

with:

publish_branch: gh-pages

github_token: ${{ secrets.GITHUB_TOKEN }}

publish_dir: docs/html

python-template/.github/workflows/docs.yaml at main · python-project-templates/python-template · GitHub

Repository navigation

Expand file tree

Breadcrumbs

docs.yaml

Latest commit

History

Breadcrumbs

docs.yaml

File metadata and controls