Skip to content

Add MkDocs for Vq and PyVq (#11) #2

Add MkDocs for Vq and PyVq (#11)

Add MkDocs for Vq and PyVq (#11) #2

Workflow file for this run

name: Publish Docs (Vq and PyVq)
on:
workflow_dispatch:
push:
branches:
- main
tags:
- "v*"
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
deploy-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
version: "latest"
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install Dependencies
run: uv sync --extra dev
- name: Build Vq Docs
run: uv run mkdocs build
- name: Build PyVq Docs
run: uv run mkdocs build --config-file pyvq/mkdocs.yml
- name: Merge Documentation Sites
run: |
mkdir -p site/python
cp -r pyvq/site/* site/python/
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
publish_branch: gh-pages
user_name: ${{ github.actor }}
user_email: ${{ github.actor }}@users.noreply.github.com
commit_message: "Deploy documentation from ${{ github.sha }} by ${{ github.actor }}"