Skip to content

Automate mkdocs deployment #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Publish docs

on:
push:
branches:
- main

permissions:
contents: write

jobs:
build-and-publish-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version-file: pyproject.toml

- name: Set up uv
uses: astral-sh/setup-uv@v5
with:
version: 0.6.11

- name: Install project
run: uv sync --group docs

- name: Deploy to GitHub Pages
run: uv run mkdocs gh-deploy
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml → .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: tests
name: Run tests

on: [pull_request, workflow_dispatch]

jobs:
build-test:
test:
runs-on: ubuntu-latest
timeout-minutes: 60
steps:
Expand Down