Skip to content

Commit 30c8663

Browse files
authored
Merge pull request #5 from rgmining/fix-docs
Fix generating docs
2 parents df85d04 + b735da9 commit 30c8663

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

.github/workflows/static.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ on:
33
push:
44
tags:
55
- "v*.*.*"
6-
workflow_dispatch:
6+
pull_request:
77
concurrency:
88
group: "pages"
99
cancel-in-progress: true
@@ -33,6 +33,7 @@ jobs:
3333
with:
3434
path: docs/build/html/
3535
deploy:
36+
if: startsWith(github.ref, 'refs/tags/v')
3637
needs: build
3738
permissions:
3839
pages: write

docs/Makefile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
# You can set these variables from the command line.
55
SPHINXOPTS =
6-
SPHINXBUILD = sphinx-build
6+
SPHINXBUILD = poetry run sphinx-build
7+
SPHINXAPIDOC = poetry run sphinx-apidoc
78
PAPER =
89
BUILDDIR = build
910

@@ -50,12 +51,12 @@ clean:
5051

5152
.PHONY: sphinx-apidoc
5253
sphinx-apidoc:
53-
sphinx-apidoc -f -o source/modules -M ".." "../setup.py" "../sample.py" "../tests"
54+
$(SPHINXAPIDOC) -f -o source/modules -M ".." "../setup.py" "../sample.py" "../tests"
5455
rm source/modules/modules.rst
5556

5657
.PHONY: sphinx-apidoc-test
5758
sphinx-apidoc-test:
58-
sphinx-apidoc -f -o source/modules -M "../tests/"
59+
$(SPHINXAPIDOC) -f -o source/modules -M "../tests/"
5960
rm source/modules/modules.rst
6061

6162
.PHONY: html

0 commit comments

Comments
 (0)