-
Notifications
You must be signed in to change notification settings - Fork 0
54 lines (49 loc) · 1.26 KB
/
docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
name: Doc
# If a pull-request is pushed then cancel all previously running jobs related
# to that pull-request
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
cancel-in-progress: true
on:
push:
branches:
- main
pull_request:
branches:
- main
env:
PY_COLORS: 1
jobs:
sphinx:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4.1.0
- name: Set up Python
uses: actions/setup-python@v4.7.0
with:
python-version: "3.11"
- name: Install dependencies
run: pip install tox
- name: Build doc
env:
TOXENV: doc
run: tox
- name: Archive generated doc
uses: actions/upload-artifact@v3.1.3
with:
name: html-doc
path: docs/_build/sphinx/html/
twine-check:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4.1.0
- name: Set up Python
uses: actions/setup-python@v4.7.0
with:
python-version: "3.11"
- name: Install dependencies
run: pip install tox twine wheel
- name: Check twine readme rendering
env:
TOXENV: twine-check
run: tox