Skip to content

Commit

Permalink
Merge pull request #317 from NLeSC/312-create-sphinx-build-action
Browse files Browse the repository at this point in the history
#312 - adding sphinx build action
  • Loading branch information
maltelueken authored Jan 10, 2023
2 parents 12218d6 + d2830e9 commit 95ddf0f
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
34 changes: 34 additions & 0 deletions .github/workflows/sphinx_build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: documentation

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
docs:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'

# this action updates pip, setuptools, and wheel before install
- name: Install Python dependencies
run: |
pip install --upgrade pip setuptools wheel
pip install .[publishing]
- name: Trigger Sphinx build
run: |
cd docs
make html
4 changes: 3 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ def read(fname):
"publishing": [
"build",
"twine",
"wheel"
"wheel",
"sphinx",
"sphinx-rtd-theme"
]
}
)

0 comments on commit 95ddf0f

Please sign in to comment.