Skip to content
This repository was archived by the owner on Feb 20, 2026. It is now read-only.

Commit 88d5917

Browse files
authored
Merge pull request #75 from dmerejkowsky/doc-workflow
Improwe documentation workflow
2 parents bacd5a2 + 8dd29a0 commit 88d5917

6 files changed

Lines changed: 217 additions & 111 deletions

File tree

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: doc-check
1+
name: doc
22

33
on:
44
push:
@@ -7,7 +7,7 @@ on:
77
pull_request:
88

99
jobs:
10-
check_doc:
10+
doc:
1111

1212
runs-on: ubuntu-latest
1313

@@ -29,9 +29,16 @@ jobs:
2929
python -m poetry run python -m pip install --upgrade pip
3030
python -m poetry install
3131
32-
- name: Check doc builds without warnings
32+
- name: Build documentation
33+
if: github.ref != 'refs/heads/main'
3334
run: |
34-
poetry run sphinx-build -W docs docs/_build/html
35-
35+
poetry run invoke sphinx
36+
37+
- name: Deploy documentation to GitHub pages
38+
uses: maxheld83/ghpages@v0.1.1
39+
if: github.ref == 'refs/heads/main'
40+
env:
41+
BUILD_DIR: docs/_build/html/
42+
GH_PAT: ${{ secrets.GH_PAT }}
3643

3744

docs/build.sh

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/deploy.sh

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)