Skip to content

Commit a9563f2

Browse files
committed
WIP: build docs on PR
1 parent 72a3a87 commit a9563f2

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# This file was modified from https://github.com/ammaraskar/sphinx-action-test/blob/master/.github/workflows/pull_request.yml
2+
3+
name: Pull Request Docs Check
4+
5+
on: [pull_request]
6+
7+
jobs:
8+
build:
9+
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v1
14+
# Standard drop-in approach that should work for most people.
15+
- uses: ammaraskar/sphinx-action@master
16+
with:
17+
docs-folder: "docs/"
18+
# Example of using a custom build-command.
19+
#- uses: ammaraskar/sphinx-action@master
20+
# with:
21+
# build-command: "sphinx-build -b html . _build"
22+
# docs-folder: "docs2/"
23+
## Grabbing custom dependencies and building as a pdf.
24+
#- uses: ammaraskar/sphinx-action@master
25+
# with:
26+
# pre-build-command: "apt-get update -y && apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended"
27+
# build-command: "make latexpdf"
28+
# docs-folder: "docs2/"
29+
# Great extra actions to compose with:
30+
# Create an artifact of the html output.
31+
- uses: actions/upload-artifact@v4
32+
with:
33+
name: DocumentationHTML
34+
path: docs/build/html/

0 commit comments

Comments
 (0)