diff options
| author | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2023-05-09 16:51:52 +0100 |
|---|---|---|
| committer | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2023-05-09 16:51:52 +0100 |
| commit | 2b1c106bbff5265e8a6076318db5d083c329d575 (patch) | |
| tree | 61b6ddf3fa2e10d128fe5e22cfb94f5289814346 | |
| parent | ba7408209e84ee413f240afc20f3c6b484a81f8f (diff) | |
| download | sphinx-git-2b1c106bbff5265e8a6076318db5d083c329d575.tar.gz | |
Update documentation workflow
- Add 'workflow_dispatch' target
- Force output to use colour
- Print traceback on error
- Use parallel building
| -rw-r--r-- | .github/workflows/builddoc.yml | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/.github/workflows/builddoc.yml b/.github/workflows/builddoc.yml index 0ad89682e..83186ad43 100644 --- a/.github/workflows/builddoc.yml +++ b/.github/workflows/builddoc.yml @@ -1,6 +1,9 @@ -name: Build document +name: Render documentation -on: [push, pull_request] +on: + push: + pull_request: + workflow_dispatch: permissions: contents: read @@ -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 @@ -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 |