pythonnative/.github/workflows/docs.yml at refs/heads/main · pythonnative/pythonnative · GitHub

Repository navigation

33 lines (30 loc) · 869 Bytes

name: Docs

on:

push:

branches: [ main ]

pull_request:

branches: [ '**' ]

permissions:

contents: write

jobs:

build:

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v4

- uses: astral-sh/setup-uv@v10.0.1

with:

enable-cache: true

python-version: '3.13'

# `uv sync` installs the project itself, which mkdocstrings needs in

# order to import and introspect it.

- name: Install docs deps

run: uv sync --locked --group docs

- name: Build site

run: uv run mkdocs build --strict

- name: Deploy to GitHub Pages

if: github.event_name == 'push' && github.ref == 'refs/heads/main'

uses: peaceiris/actions-gh-pages@v3

with:

github_token: ${{ secrets.GITHUB_TOKEN }}

publish_dir: ./site

cname: pythonnative.com