Skip to content

Commit 1a6a1a8

Browse files
committed
chore: manually trigger docs
Allowing for manual trigger of docs workflow
1 parent 756ab1c commit 1a6a1a8

6 files changed

Lines changed: 63 additions & 20 deletions

File tree

.github/workflows/docs.yml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
name: Publish Docs
22
on:
3+
workflow_dispatch:
34
push:
45
branches:
56
- main
@@ -17,19 +18,19 @@ jobs:
1718
- name: Checkout
1819
uses: actions/checkout@v4
1920

20-
- name: Install PIP Dependencies
21-
uses: actions/setup-python@v5
22-
with:
23-
cache: 'pip'
24-
- run: |
25-
cd docs
26-
python -m pip install pyproject.toml
21+
- name: Install UV
22+
uses: astral-sh/setup-uv@v7
23+
24+
- name: Set up Python
25+
run: uv python install
26+
27+
- name: Install the project
28+
run: uv sync --locked --all-groups --directory ./docs
2729

2830
- name: Build Docs
2931
run: |
30-
git fetch --tags
31-
cd docs
32-
sphinx-multiversion docs docs/build
32+
git fetch --all
33+
uv run --directory ./docs sphinx-multiversion . build
3334
3435
- name: Setup Pages
3536
uses: actions/configure-pages@v5

.github/workflows/tests.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
name: Tests
22
on:
3-
push:
4-
branches:
5-
- main
6-
- 1.x
73
pull_request:
84
branches:
95
- main
106
- 1.x
7+
- 2.x
118
workflow_dispatch:
129

1310
jobs:

docs/.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
.python-version
21
build
32
bin
43
include

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@
4444
highlight_language = "php"
4545

4646
smv_tag_whitelist = r'^.*$'
47-
smv_branch_whitelist = r'^.*$'
48-
smv_remote_whitelist = r'^head/(\d\.x|main)$'
47+
smv_branch_whitelist = r'^(\d\.x|main)$'
48+
smv_remote_whitelist = r'^.*$'
4949
smv_released_pattern = r'^tags/.*$'
5050
smv_outputdir_format = '{ref.name}'
5151
smv_prefer_remote_refs = False

docs/requirements.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
alabaster==1.0.0
2+
babel==2.17.0
3+
certifi==2025.11.12
4+
charset-normalizer==3.4.4
5+
docutils==0.22.4
6+
idna==3.11
7+
imagesize==1.4.1
8+
Jinja2==3.1.6
9+
MarkupSafe==3.0.3
10+
packaging==25.0
11+
Pygments==2.19.2
12+
requests==2.32.5
13+
roman-numerals==4.1.0
14+
snowballstemmer==3.0.1
15+
Sphinx==9.0.4
16+
sphinx-multiversion==0.2.4
17+
sphinxcontrib-applehelp==2.0.0
18+
sphinxcontrib-devhelp==2.0.0
19+
sphinxcontrib-htmlhelp==2.1.0
20+
sphinxcontrib-jsmath==1.0.1
21+
sphinxcontrib-qthelp==2.0.0
22+
sphinxcontrib-serializinghtml==2.0.0
23+
urllib3==2.6.2
24+
uv==0.9.18

docs/uv.lock

Lines changed: 25 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)