Skip to content

Commit a204fe6

Browse files
committed
git ignore documentation build directory
Signed-off-by: Luc Berger-Vergiat <[email protected]>
1 parent 9729472 commit a204fe6

File tree

2 files changed

+30
-5
lines changed

2 files changed

+30
-5
lines changed

.github/workflows/docs.yml

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,13 @@ name: github-DOCS
22

33
on:
44
pull_request:
5-
branches:
6-
- master
7-
- develop
5+
types: [ opened, reopened, synchronize ]
86

97
permissions:
108
contents: none
119

1210
jobs:
13-
docs-check:
11+
build:
1412
runs-on: [macos-latest]
1513
steps:
1614
- name: checkout_kokkos_kernels
@@ -21,6 +19,7 @@ jobs:
2119
- name: Install Dependencies
2220
run: |
2321
brew install doxygen
22+
python3 --version
2423
python3 -m venv .venv
2524
. .venv/bin/activate
2625
pip install -r kokkos-kernels/docs/build_requirements.txt
@@ -31,4 +30,27 @@ jobs:
3130
run: |
3231
. .venv/bin/activate
3332
cd kokkos-kernels/docs
34-
make
33+
make html
34+
35+
- name: Updload documentation as artifact
36+
id: deployment
37+
uses: actions/[email protected]
38+
with:
39+
name: github-pages
40+
path: kokkos-kernels/docs/generated_docs
41+
42+
# deploy:
43+
# if: ${{ github.ref == 'refs/heads/main' }}
44+
# environment:
45+
# name: github-pages
46+
# url: ${{ steps.deployment.outputs.page_url }}
47+
# runs-on: [macos-latest]
48+
# needs: build
49+
# permissions:
50+
# contents: read
51+
# pages: write # to deploy to Pages
52+
# id-token: write # to verify the deployment originates from an appropriate source
53+
# steps:
54+
# - name: Deploy to GitHub Pages
55+
# id: deployment
56+
# uses: actions/[email protected]

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,6 @@ compile_commands.json
1616

1717
#MacOS hidden files
1818
.DS_Store
19+
20+
#Documentation build
21+
docs/generated_docs/

0 commit comments

Comments
 (0)