Skip to content

Commit f50dd12

Browse files
committed
docs: added documentation
1 parent 8315112 commit f50dd12

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: documentation
2+
3+
on:
4+
push:
5+
pull_request:
6+
workflow_dispatch:
7+
inputs:
8+
deploy:
9+
description: 'Deploy documentation'
10+
required: false
11+
type: boolean
12+
13+
permissions:
14+
contents: write
15+
16+
jobs:
17+
docs:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-python@v5
22+
- name: Install dependencies
23+
run: |
24+
pip install --disable-pip-version-check uv
25+
uv sync --frozen --group docs
26+
- name: Sphinx build
27+
run: |
28+
uv run --frozen --group docs sphinx-build docs _build
29+
- name: Deploy to GitHub Pages
30+
uses: peaceiris/actions-gh-pages@v4
31+
if: github.event_name == 'workflow_dispatch' && github.event.inputs.deploy == 'true'
32+
with:
33+
publish_branch: gh-pages
34+
github_token: ${{ secrets.GITHUB_TOKEN }}
35+
publish_dir: _build/
36+
force_orphan: true

ci/docker/python/linux/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ FROM python:${PYTHON_VERSION} AS base_image
66
#==============================================================================
77
FROM base_image
88
RUN apt-get update && \
9-
apt-get install -y npm && \
9+
apt-get install -y --no-install-recommends npm libenchant-2-dev && \
1010
apt-get clean && \
1111
rm -rf /var/lib/apt/lists/*
1212

0 commit comments

Comments
 (0)