8000 Update documentation workflow · sphinx-doc/sphinx@2b1c106 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2b1c106

Browse files
AA-TurnerAA-Turner
committed
Update documentation workflow
- Add 'workflow_dispatch' target - Force output to use colour - Print traceback on error - Use parallel building
1 parent ba74082 commit 2b1c106

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

‎.github/workflows/builddoc.yml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
name: Build document
1+
name: Render documentation
22

3-
on: [push, pull_request]
3+
on:
4+
push:
5+
pull_request:
6+
workflow_dispatch:
47

58
permissions:
69
contents: read
@@ -9,6 +12,9 @@ concurrency:
912
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
1013
cancel-in-progress: true
1114

15+
env:
16+
FORCE_COLOR: "1"
17+
1218
jobs:
1319
build:
1420
runs-on: ubuntu-latest
@@ -27,11 +33,11 @@ jobs:
2733
python -m pip install .[docs]
2834
- name: Render the documentation
2935
run: >
30-
python
31-
-X dev
32-
-X warn_default_encoding
33-
-m sphinx
36+
sphinx-build
3437
-M html ./doc ./build/sphinx
38+
-T
3539
-W
40+
--jobs=auto
3641
-n
42+
-vvv
3743
--keep-going

0 commit comments

Comments
 (0)
0