FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
moabb/.github/workflows/docs.yml at develop · NeuralLabBIT/moabb · GitHub
NeuralLabBIT
moabb
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
moabb
/
.github
/
workflows
/
docs.yml
Copy path
View runs
More file actions
More file actions
Latest commit
History
History
History
191 lines (162 loc) · 5.54 KB
Breadcrumbs
moabb
/
.github
/
workflows
/
docs.yml
Copy path
File metadata and controls
191 lines (162 loc) · 5.54 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
name
:
Docs
on
:
push
:
branches
:
[master, develop]
pull_request
:
branches
:
[master, develop]
jobs
:
build_docs
:
runs-on
:
${{ matrix.os }}
strategy
:
fail-fast
:
true
matrix
:
os
:
[ubuntu-latest]
python-version
:
["3.9"]
steps
:
-
uses
:
actions/checkout@v3
-
name
:
Create local data folder
run
:
|
mkdir ~/mne_data
-
name
:
Setup Python
uses
:
actions/setup-python@v4
with
:
python-version
:
${{ matrix.python-version }}
-
name
:
Install Poetry
uses
:
snok/install-poetry@v1
with
:
virtualenvs-create
:
true
virtualenvs-in-project
:
true
-
name
:
Cache datasets and docs
id
:
cached-dataset-docs
uses
:
actions/cache@v3
with
:
key
:
doc-${{ github.head_ref }}-${{ hashFiles('moabb/datasets/**') }}
path
:
|
~/mne_data
docs/build
-
name
:
Install dependencies
if
:
steps.cached-dataset-docs.outputs.cache-hit != 'true'
run
:
poetry install --no-interaction --no-root --with docs,deeplearning
-
name
:
Install library
run
:
poetry install --no-interaction --with docs,deeplearning
-
name
:
Build docs
run
:
|
cd docs && poetry run make html
#
Create an artifact of the html output.
-
uses
:
actions/upload-artifact@v2
with
:
name
:
DocumentationHTML
path
:
docs/build/html/
deploy_docs
:
if
:
${{ github.ref == 'refs/heads/master' }}
needs
:
build_docs
runs-on
:
${{ matrix.os }}
strategy
:
fail-fast
:
false
matrix
:
os
:
[ubuntu-latest]
steps
:
-
uses
:
actions/checkout@v3
-
name
:
Create local data folder
run
:
|
mkdir ~/mne_data
-
name
:
Cache datasets and docs
id
:
cached-dataset-docs
uses
:
actions/cache@v3
with
:
key
:
doc-${{ github.head_ref }}-${{ hashFiles('moabb/datasets/**') }}
path
:
|
~/mne_data
docs/build
-
name
:
Checkout moabb.github.io
uses
:
actions/checkout@v3
with
:
repository
:
"
NeuroTechX/moabb.github.io
"
path
:
moabb-ghio
token
:
${{ secrets.MOABB_GHIO }}
-
name
:
Deploy on moabb.neurotechx.com
run
:
|
git config --global user.email "ci@neurotechx.com"
git config --global user.name "Github Actions"
cd ~/work/moabb/moabb/moabb-ghio
rm -Rf docs
cp -a ~/work/moabb/moabb/docs/build/html ./docs
git add -A
git commit -m "GH Actions update of docs ($GITHUB_RUN_ID - $GITHUB_RUN_NUMBER)"
git push origin master
deploy_gh_pages
:
if
:
${{ github.ref == 'refs/heads/develop' }}
needs
:
build_docs
runs-on
:
${{ matrix.os }}
strategy
:
fail-fast
:
false
matrix
:
os
:
[ubuntu-latest]
steps
:
-
uses
:
actions/checkout@v3
-
name
:
Create local data folder
run
:
|
mkdir ~/mne_data
-
name
:
Cache datasets and docs
id
:
cached-dataset-docs
uses
:
actions/cache@v3
with
:
key
:
doc-${{ github.head_ref }}-${{ hashFiles('moabb/datasets/**') }}
path
:
|
~/mne_data
docs/build
-
name
:
Checkout gh pages
uses
:
actions/checkout@v3
with
:
ref
:
gh-pages
path
:
moabb-ghpages
-
name
:
Deploy on gh-pages
run
:
|
git config --global user.email "ci@neurotechx.com"
git config --global user.name "Github Actions"
cd ~/work/moabb/moabb/moabb-ghpages
rm -Rf docs
cp -a ~/work/moabb/moabb/docs/build/html ./docs
git add -A
git commit -m "GH Actions update of GH pages ($GITHUB_RUN_ID - $GITHUB_RUN_NUMBER)"
git push origin gh-pages
#
Previous test with moabb GH pages, official docs point to moabb.github.io
#
##########################################################################
#
Since we want the URL to be neurotechx.github.io/docs/ the html output needs to be put in a ./docs subfolder of the publish_dir
#
- name: Move docs into site folder
#
run: |
#
mkdir site
#
mv docs/build/html site/docs
#
- name: Deploy on moabb gh-pages
#
uses: peaceiris/actions-gh-pages@v3
#
if: github.ref == 'refs/heads/master'
#
with:
#
github_token: ${{ secrets.GITHUB_TOKEN }}
#
publish_dir: site
#
Using checkout and push actions, not working
#
#############################################
#
- name: Install SSH key
#
uses: shimataro/ssh-key-action@v2
#
with:
#
key: ${{ secrets.MOABB_DOCS_SSH }}
#
known_hosts: ${{ secrets.KNOWN_HOST_GH }}
#
- name: Checkout moabb.github.io
#
uses: actions/checkout@v2
#
with:
#
repository: "NeuroTechX/moabb.github.io"
#
path: moabb-ghio
#
fetch-depth: 0
#
persist-credentials: false
#
- name: Add html files
#
run: |
#
cd ~/work/moabb/moabb/moabb-ghio
#
rm -Rf docs
#
cp -a ~/work/moabb/moabb/docs/build/html ./docs
#
git config --global user.email "ci@neurotechx.com"
#
git config --global user.name "Github Actions"
#
git commit -m "GH Actions update of docs ($GITHUB_RUN_ID - $GITHUB_RUN_NUMBER)" -a
#
- name: Push
#
uses: ad-m/github-push-action@master
#
with:
#
github_token: ${{ secrets.MOABB_GHIO }}
#
repository: "NeuroTechX/moabb.github.io"
Back
|
FazBrowse Home
|
New Git URL