1
- name : Build and deploy Sphinx documentation
1
+ name : Build and deploy docs
2
2
3
3
on :
4
- push :
5
- # Run when new version tag is pushed
6
- tags :
7
- - v*
4
+ # Push trigger is disabled because the Docker container that builds the docs
5
+ # in this workflow will not have the new tag, meaning the API reference would
6
+ # have the wrong version tag displayed (commit would still be correct). Need to
7
+ # build a new Docker image and then use that to build and deploy the docs.
8
+ # push:
9
+ # # Run when new version tag is pushed
10
+ # tags:
11
+ # - v*
8
12
9
13
# Allows running manually from the Actions tab
10
14
workflow_dispatch :
@@ -17,11 +21,11 @@ jobs:
17
21
run :
18
22
shell : bash
19
23
steps :
20
- - name : Build Sphinx docs
24
+ - name : Build docs
21
25
run : |
22
26
mkdir -p docs/_build
23
27
docker run ghcr.io/${{ github.repository }}:latest make docs
24
- docker cp $(docker ps -q -l):/opt/colcon_ws/src/gisnav/docs/_build docs
28
+ docker cp $(docker ps -q -l):/opt/colcon_ws/src/gisnav/docs/vitepress/docs/dist docs
25
29
26
30
- name : Install node
27
31
run : |
@@ -30,19 +34,13 @@ jobs:
30
34
curl -fsSL https://deb.nodesource.com/setup_18.x | bash -
31
35
sudo apt-get install -y nodejs
32
36
33
- - name : Setup pages
37
+ - name : Configure pages
34
38
uses : actions/configure-pages@v1
35
39
36
- # - name: Make "Upload pages artifact" step work with containers
37
- # run: |
38
- # mkdir -p ${{runner.temp}}
39
- # mkdir -p /__w/_temp
40
- # ln -s ${{runner.temp}}/artifact.tar /__w/_temp/artifact.tar
41
-
42
40
- name : Upload pages artifact
43
41
uses : actions/upload-pages-artifact@v2
44
42
with :
45
- path : ' docs/_build/html/ '
43
+ path : " docs"
46
44
47
45
deploy :
48
46
needs : build
58
56
59
57
runs-on : ubuntu-20.04
60
58
steps :
61
- - name : Deploy to GitHub Pages
59
+ - name : Deploy pages
62
60
id : deployment
63
61
uses : actions/deploy-pages@v3
0 commit comments