Skip to content

Commit

Permalink
Update documentation workflow
Browse files Browse the repository at this point in the history
- Add 'workflow_dispatch' target
- Force output to use colour
- Print traceback on error
- Use parallel building
  • Loading branch information
AA-Turner committed May 9, 2023
1 parent ba74082 commit 2b1c106
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions .github/workflows/builddoc.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: Build document
name: Render documentation

on: [push, pull_request]
on:
push:
pull_request:
workflow_dispatch:

permissions:
contents: read
Expand All @@ -9,6 +12,9 @@ concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

env:
FORCE_COLOR: "1"

jobs:
build:
runs-on: ubuntu-latest
Expand All @@ -27,11 +33,11 @@ jobs:
python -m pip install .[docs]
- name: Render the documentation
run: >
python
-X dev
-X warn_default_encoding
-m sphinx
sphinx-build
-M html ./doc ./build/sphinx
-T
-W
--jobs=auto
-n
-vvv
--keep-going

0 comments on commit 2b1c106

Please sign in to comment.