Skip to content
This repository was archived by the owner on Mar 3, 2026. It is now read-only.

Commit c657b56

Browse files
authored
Build all languages on RTD in a single pass (#26)
1 parent 1d0df03 commit c657b56

4 files changed

Lines changed: 39 additions & 8 deletions

File tree

.github/workflows/ci.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,35 @@ jobs:
2424
uses: beeware/.github/.github/workflows/pre-commit-run.yml@main
2525
with:
2626
pre-commit-source: "--group pre-commit"
27+
28+
lint:
29+
needs: [ pre-commit ]
30+
runs-on: ubuntu-latest
31+
timeout-minutes: 5
32+
steps:
33+
- name: Checkout
34+
uses: actions/[email protected]
35+
with:
36+
fetch-depth: 1
37+
38+
- name: Set up Python
39+
uses: actions/[email protected]
40+
with:
41+
python-version: "3.X"
42+
cache: pip
43+
cache-dependency-path: |
44+
pyproject.toml
45+
.pre-commit-config.yaml
46+
47+
- name: Install system dependencies
48+
run: |
49+
sudo apt-get install aspell aspell-en
50+
51+
- name: Update pip
52+
run: python -m pip install -U pip
53+
54+
- name: Install Tox
55+
run: python -m pip install --group 'tox-uv'
56+
57+
- name: Perform lint checks
58+
run: python -m tox -e docs-lint

.readthedocs.yaml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,12 @@ version: 2
99
build:
1010
os: ubuntu-24.04
1111
tools:
12-
# Docs are always built on Python 3.12. See also the tox config.
13-
python: "3.12"
12+
# Docs are always built on Python 3.13. See also the tox config.
13+
python: "3.13"
1414
jobs:
1515
pre_install:
1616
- python -m pip install --upgrade pip
1717
- python -m pip install --group 'tox-uv'
18-
pre_build:
19-
- python -m tox -e docs-lint
2018
build:
2119
html:
22-
- python -m tox -e docs-$READTHEDOCS_LANGUAGE -- --output=$READTHEDOCS_OUTPUT/html/
20+
- python -m tox -e docs-all -- --output=$READTHEDOCS_OUTPUT/html/

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ dev = [
2222

2323
docs = [
2424
"beeware-docs-tools @ git+https://github.com/beeware/beeware-docs-tools",
25+
# "beeware-docs-tools @ file://../beeware-docs-tools",
2526
{include-group = "redirects"},
2627
]
2728

tox.ini

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ envlist = docs-lint,docs-all
55
docs_dir = {tox_root}{/}docs{/}en
66

77
[testenv:docs{,-translate,-lint,-en,-ar,-cs,-da,-de,-es,-fa,-fr,-it,-ko,-pl,-pt,-tr,-zh-cn,-zh-tw,-all,-serve,-live}]
8-
# Docs are always built on Python 3.12. See also the RTD config.
9-
base_python = py312
8+
# Docs are always built on Python 3.13. See also the RTD config.
9+
base_python = py313
1010
skip_install = true
1111
passenv =
1212
DEEPL_API_KEY
@@ -34,5 +34,5 @@ commands:
3434
zh-cn : build_md_translations {posargs} zh_CN
3535
zh-tw : build_md_translations {posargs} zh_TW
3636
all : build_md_translations {posargs} en ar cs da de es fa fr it ko pl pt tr zh_CN zh_TW
37-
serve : python -m http.server -d _build/html
37+
serve : python -m http.server -d _build/html 8042
3838
live : live_serve_en {posargs} --port=8042

0 commit comments

Comments
 (0)