Skip to content

Commit 2ebe0ce

Browse files
committed
Update github docs workflo [skip ci]
1 parent 787f1f6 commit 2ebe0ce

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed
Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1-
name: Build and deploy Sphinx documentation
1+
name: Build and deploy docs
22

33
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*
812

913
# Allows running manually from the Actions tab
1014
workflow_dispatch:
@@ -17,11 +21,11 @@ jobs:
1721
run:
1822
shell: bash
1923
steps:
20-
- name: Build Sphinx docs
24+
- name: Build docs
2125
run: |
2226
mkdir -p docs/_build
2327
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
2529
2630
- name: Install node
2731
run: |
@@ -30,19 +34,13 @@ jobs:
3034
curl -fsSL https://deb.nodesource.com/setup_18.x | bash -
3135
sudo apt-get install -y nodejs
3236
33-
- name: Setup pages
37+
- name: Configure pages
3438
uses: actions/configure-pages@v1
3539

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-
4240
- name: Upload pages artifact
4341
uses: actions/upload-pages-artifact@v2
4442
with:
45-
path: 'docs/_build/html/'
43+
path: "docs"
4644

4745
deploy:
4846
needs: build
@@ -58,6 +56,6 @@ jobs:
5856

5957
runs-on: ubuntu-20.04
6058
steps:
61-
- name: Deploy to GitHub Pages
59+
- name: Deploy pages
6260
id: deployment
6361
uses: actions/deploy-pages@v3

0 commit comments

Comments
 (0)