-
Notifications
You must be signed in to change notification settings - Fork 0
112 lines (95 loc) · 2.69 KB
/
documentation.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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
name: documentation
on:
push:
branches:
- main
jobs:
documentation:
runs-on: ubuntu-latest
steps:
- name: Checkout the repo
uses: actions/checkout@v3
- name: Set up Python 3.9
uses: actions/setup-python@v4
with:
python-version: 3.9
- name: Install poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
- name: Load cached venv
id: cached-poetry-dependencies
uses: actions/cache@v3
with:
path: .venv
key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
- name: Install dependencies
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: |
poetry install --no-interaction --no-root
- name: Install library
run: |
poetry install --no-interaction
- name: Generate documentation with Sphinx
run: |
source .venv/bin/activate
make docs
touch docs/_build/html/.nojekyll
- name: Publish docs
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: docs/_build/html
clean-exclude: |
_badges
_coverage
- name: Generate style badge
uses: knightdave/[email protected]
with:
file: docs/_badges/style.svg
label: code style
value: black
color: black
template: docs/_badges/template.svg
overwrite: true
- name: Extract license
run: |
echo "LICENSE=$(grep -oP 'license = "\K([A-z-0-9]+)(?=")' pyproject.toml)" >> $GITHUB_ENV
- name: Generate license badge
uses: knightdave/[email protected]
with:
file: docs/_badges/license.svg
label: license
value: ${{ env.LICENSE }}
color: yellowgreen
template: docs/_badges/template.svg
overwrite: true
- name: Generate passing badge
if: success()
uses: knightdave/[email protected]
with:
file: docs/_badges/documentation.svg
label: docs
value: passing
color: green
template: docs/_badges/template.svg
overwrite: true
- name: Generate failing badge
if: failure()
uses: knightdave/[email protected]
with:
file: docs/_badges/documentation.svg
label: docs
value: failing
color: red
template: docs/_badges/template.svg
overwrite: true
- name: Publish badge
if: success() || failure()
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: docs/_badges
target-folder: _badges
clean: false