Skip to content

Commit f9eb3f1

Browse files
Add github action to build docs for testing purposes (#41)
Signed-off-by: Johannes Mueller <johannes.mueller4@de.bosch.com>
1 parent 56150ff commit f9eb3f1

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

.github/workflows/docs.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Documentation
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- master
8+
- develop
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
env:
14+
MPLBACKEND: svg
15+
PYDEVD_DISABLE_FILE_VALIDATION: 1
16+
strategy:
17+
fail-fast: false
18+
19+
steps:
20+
- uses: actions/checkout@v3
21+
- name: Set up Python 3.11
22+
uses: actions/setup-python@v4
23+
with:
24+
python-version: 3.11
25+
- name: Install dependencies
26+
run: |
27+
python -m pip install --upgrade pip
28+
pip install -U setuptools setuptools_scm wheel
29+
pip install -e .[all,docs]
30+
sudo apt-get install pandoc
31+
- name: Build docs
32+
run: sphinx-build -b html docs _build/html

setup.cfg

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ docs =
8787
pyvista[all,jupyter]
8888
trame<3
8989
ipywidgets
90+
ipython<8.17.0 # https://github.com/ipython/ipython/issues/14235
91+
ipykernel
9092
xvfbwrapper
9193

9294

0 commit comments

Comments
 (0)