-
Notifications
You must be signed in to change notification settings - Fork 0
171 lines (144 loc) · 4.56 KB
/
doc.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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
name: Documentation Tests
on: [push, pull_request]
jobs:
Doc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
chmod +x .github/scripts/install_libiio.sh
./.github/scripts/install_libiio.sh
pip install -r requirements_dev.txt
pip install -r doc/requirements.txt
- name: Build doc
run: |
cd doc && make html
cd ..
CheckDocs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
chmod +x .github/scripts/install_libiio.sh
./.github/scripts/install_libiio.sh
pip install -r requirements_dev.txt
pip install -r doc/requirements.txt
- name: Check doc build
run: |
cd doc
make html SPHINXOPTS="-W"
cd ..
- name: Check doc coverage
run: |
cd doc
make coverage
cat build/coverage/python.txt
cat build/coverage/python.txt | wc -l | xargs -I % test % -eq 2
cd ..
- name: Check doc links
run: |
cd doc
make linkcheck
cd ..
DeployMainDoc:
runs-on: ubuntu-latest
needs: [CheckDocs, Doc]
if: github.ref == 'refs/heads/main'
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
chmod +x .github/scripts/install_libiio.sh
./.github/scripts/install_libiio.sh
pip install -r requirements_dev.txt
pip install -r doc/requirements.txt
- name: Build doc and release
run: |
cd doc && make html
cd ..
- name: Publish doc
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/build/html
destination_dir: main
DeployDevelopmentDoc:
runs-on: ubuntu-latest
needs: [CheckDocs, Doc]
# Only run on pull requests to main and non-forks
if: github.event_name == 'pull_request' && github.base_ref == 'main' && ! github.event.pull_request.head.repo.fork
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
chmod +x .github/scripts/install_libiio.sh
./.github/scripts/install_libiio.sh
pip install -r requirements_dev.txt
pip install -r doc/requirements.txt
- name: Build doc and release
run: |
export GIT_BRANCH=${{ github.head_ref }}
export DEV_BUILD=1
cd doc && make html
cd ..
- name: Publish doc
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/build/html
destination_dir: prs/${{ github.head_ref }}
- name: Add comment to PR
uses: mshick/add-pr-comment@v2
with:
message: |
Generated documentation for this PR is available at [Link](https://analogdevicesinc.github.io/pyadi-iio/prs/${{ github.head_ref }}/index.html)
Deploy:
runs-on: ubuntu-latest
needs: [Doc]
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
chmod +x .github/scripts/install_libiio.sh
./.github/scripts/install_libiio.sh
pip install -r requirements_dev.txt
pip install -r doc/requirements.txt
pip install setuptools wheel twine build
- name: Build doc and release
run: |
cd doc && make html
cd ..
python -m build
- name: Publish doc
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/build/html
# - name: Publish package
# uses: pypa/gh-action-pypi-publish@master
# with:
# user: __token__
# password: ${{ secrets.PYPI_TOKEN }}