Skip to content

Commit 6065159

Browse files
committed
moved docs to new workflow
1 parent 662dc7c commit 6065159

File tree

2 files changed

+42
-20
lines changed

2 files changed

+42
-20
lines changed

.github/workflows/ci_pipeline.yml

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
- name: Install python dependencies
2929
run: |
3030
python -m pip install --upgrade pip
31-
pip install ".[test]"
31+
pip install ".[dev]"
3232
3333
- name: Inspect maxplotlib arguments
3434
run: |
@@ -38,24 +38,7 @@ jobs:
3838
run: |
3939
coverage run -m pytest .
4040
coverage report --sort=cover
41-
build_docs:
42-
runs-on: ubuntu-latest
43-
steps:
44-
- name: Check out the code
45-
uses: actions/checkout@v3
46-
47-
- name: Install python dependencies
48-
run: |
49-
python -m pip install --upgrade pip
50-
pip install ".[docs]"
5141
52-
- name: Build Sphinx documentation
42+
- name: Test tutorials
5343
run: |
54-
cd docs/
55-
make html
56-
57-
- name: Upload built docs as artifact
58-
uses: actions/upload-artifact@v4
59-
with:
60-
name: html-docs
61-
path: docs/build/html/
44+
jupyter nbconvert --to notebook --execute tutorials/*.ipynb --output-dir=/tmp --ExecutePreprocessor.timeout=300

.github/workflows/docs.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Build docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- devel
8+
pull_request:
9+
branches:
10+
- main
11+
- devel
12+
13+
jobs:
14+
build_docs:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Check out the code
18+
uses: actions/checkout@v3
19+
20+
- name: Install Pandoc
21+
run: |
22+
sudo apt-get update
23+
sudo apt-get install -y pandoc
24+
25+
- name: Install python dependencies
26+
run: |
27+
python -m pip install --upgrade pip
28+
pip install ".[docs]"
29+
30+
- name: Build Sphinx documentation
31+
run: |
32+
cd docs/
33+
make html
34+
35+
- name: Upload built docs as artifact
36+
uses: actions/upload-artifact@v4
37+
with:
38+
name: html-docs
39+
path: docs/build/html/

0 commit comments

Comments
 (0)