Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add github action to build docs for testing purposes #41

Merged
merged 9 commits into from
Nov 22, 2023
32 changes: 32 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Documentation

on:
pull_request:
push:
branches:
- master
- develop

jobs:
build:
runs-on: ubuntu-latest
env:
MPLBACKEND: svg
PYDEVD_DISABLE_FILE_VALIDATION: 1
strategy:
fail-fast: false

steps:
- uses: actions/checkout@v3
- name: Set up Python 3.11
uses: actions/setup-python@v4
with:
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -U setuptools setuptools_scm wheel
pip install -e .[all,docs]
sudo apt-get install pandoc
- name: Build docs
run: sphinx-build -b html docs _build/html
2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ docs =
pyvista[all,jupyter]
trame<3
ipywidgets
ipython<8.17.0 # https://github.com/ipython/ipython/issues/14235
ipykernel
xvfbwrapper


Expand Down