-
Notifications
You must be signed in to change notification settings - Fork 3
130 lines (128 loc) · 3.49 KB
/
sphinx.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
name: "Sphinx: Render docs"
<<<<<<< HEAD
<<<<<<< HEAD
# on: push
on:
workflow_call:
=======
on: push
>>>>>>> c029ef6 (initial loading of sphinx api documentation)
=======
# on: push
on:
workflow_call:
>>>>>>> 90b2a92 (docker container and ci workflow)
jobs:
build:
runs-on: ubuntu-latest
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
=======
>>>>>>> d276d08 (without docker)
# container:
# image: ghcr.io/llnl/gplasdi/lasdi_env:latest
# options: --user 1001 --privileged
# volumes:
# - /mnt:/mnt
permissions:
contents: write
steps:
- name: Cancel previous runs
uses: styfle/[email protected]
with:
access_token: ${{ github.token }}
- uses: actions/checkout@v4
- name: Build HTML
<<<<<<< HEAD
<<<<<<< HEAD
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
build-command: "sphinx-build -b html source build"
pre-build-command: "pip install --upgrade pip && pip install sphinx-autoapi sphinx_rtd_theme"
=======
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
<<<<<<< HEAD
build-command: "sphinx-build -b html . build"
pre-build-command: "pip install sphinx-autoapi sphinx_rtd_theme"
>>>>>>> 830ee33 (another try..)
=======
build-command: "sphinx-build -b html source build"
pre-build-command: "pip install --upgrade pip && pip install sphinx-autoapi sphinx_rtd_theme"
>>>>>>> d276d08 (without docker)
# run: |
# sphinx-build --version
# cd ${GITHUB_WORKSPACE}/docs
# mkdir build
# sphinx-build -b html source/ build/
<<<<<<< HEAD
<<<<<<< HEAD
- name: check resulting files
run: |
ls ${GITHUB_WORKSPACE}/docs/build
=======
=======
container:
image: ghcr.io/llnl/gplasdi/lasdi_env:latest
options: --user 1001 --privileged
volumes:
- /mnt:/mnt
>>>>>>> 90b2a92 (docker container and ci workflow)
permissions:
contents: write
steps:
- name: Cancel previous runs
uses: styfle/[email protected]
with:
access_token: ${{ github.token }}
- uses: actions/checkout@v4
- name: Build HTML
uses: ammaraskar/sphinx-action@master
>>>>>>> c029ef6 (initial loading of sphinx api documentation)
=======
# uses: ammaraskar/sphinx-action@master
run: |
sphinx-build --version
sphinx-build -b html source/ build/
>>>>>>> 9528f00 (custom build command instead of github action)
=======
>>>>>>> 830ee33 (another try..)
=======
- name: check resulting files
run: |
ls ${GITHUB_WORKSPACE}/docs/build
<<<<<<< HEAD
ls ${GITHUB_WORKSPACE}/docs/build/html
>>>>>>> 3afbe7f (check resulting file)
=======
>>>>>>> 6a4851d (fix artifact path)
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
<<<<<<< HEAD
<<<<<<< HEAD
path: docs/build/
=======
path: docs/build/html/
>>>>>>> c029ef6 (initial loading of sphinx api documentation)
=======
path: docs/build/
>>>>>>> 6a4851d (fix artifact path)
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
# if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
<<<<<<< HEAD
<<<<<<< HEAD
publish_dir: docs/build
=======
publish_dir: docs/build/html
>>>>>>> c029ef6 (initial loading of sphinx api documentation)
=======
publish_dir: docs/build
>>>>>>> 6a4851d (fix artifact path)