mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Update documentation workflow
- Add 'workflow_dispatch' target - Force output to use colour - Print traceback on error - Use parallel building
This commit is contained in:
parent
ba7408209e
commit
2b1c106bbf
18
.github/workflows/builddoc.yml
vendored
18
.github/workflows/builddoc.yml
vendored
@ -1,6 +1,9 @@
|
|||||||
name: Build document
|
name: Render documentation
|
||||||
|
|
||||||
on: [push, pull_request]
|
on:
|
||||||
|
push:
|
||||||
|
pull_request:
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
@ -9,6 +12,9 @@ concurrency:
|
|||||||
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
|
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
|
||||||
cancel-in-progress: true
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
env:
|
||||||
|
FORCE_COLOR: "1"
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@ -27,11 +33,11 @@ jobs:
|
|||||||
python -m pip install .[docs]
|
python -m pip install .[docs]
|
||||||
- name: Render the documentation
|
- name: Render the documentation
|
||||||
run: >
|
run: >
|
||||||
python
|
sphinx-build
|
||||||
-X dev
|
|
||||||
-X warn_default_encoding
|
|
||||||
-m sphinx
|
|
||||||
-M html ./doc ./build/sphinx
|
-M html ./doc ./build/sphinx
|
||||||
|
-T
|
||||||
-W
|
-W
|
||||||
|
--jobs=auto
|
||||||
-n
|
-n
|
||||||
|
-vvv
|
||||||
--keep-going
|
--keep-going
|
||||||
|
Loading…
Reference in New Issue
Block a user