Skip to content

API Reference 추가 #17

API Reference 추가

API Reference 추가 #17

Workflow file for this run

# 워크플로 이름
name: Deploy MkDocs to GitHub Pages
# 워크플로 실행 조건: master 브랜치에 push 될 때마다 실행
on:
push:
branches:
- master
# 수동으로 워크플로를 실행할 수 있도록 허용
workflow_dispatch:
# 배포 작업에 필요한 권한 설정
permissions:
contents: read
pages: write
id-token: write
jobs:
build-and-deploy:
# 실행 환경
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v5
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
enable-cache: true
- name: Set up Python
run: uv python install
- name: Install the project
run: uv sync --locked --all-extras --dev
- name: Build MkDocs site
run: |
uv run mkdocs build --config-file mkdocs.en.yml
uv run mkdocs build --config-file mkdocs.ko.yml
- name: Create redirect page
run: |
echo '<!DOCTYPE html><html><head><meta http-equiv="refresh" content="0; url=./en/"></head><body></body></html>' > site/index.html
- name: Upload GitHub Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4